The Nyuchi API is a single FastAPI gateway hosted atDocumentation Index
Fetch the complete documentation index at: https://nyuchidocs-mintlify-nyuchi-api-gateway-1778247744.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
api.nyuchi.com. Every product surface is mounted under /v1/<name>/* and is backed by its own Supabase project, so each product can scale, isolate, and meter independently. A single Stytch-derived platform JWT authorises requests across every namespace.
Use this guide when you need to call a product surface from a frontend, a server-to-server integration, or a partner application.
Base URL and versioning
| Environment | Base URL |
|---|---|
| Production | https://api.nyuchi.com |
| Local development | http://localhost:8080 |
/v1 prefix. The API version is reported by GET / in the api_version field. Legacy /api/* paths from earlier releases no longer resolve—update existing clients to /v1/*.
Namespace map
Each namespace maps to a dedicated Supabase project.| Namespace | Database | Purpose |
|---|---|---|
/v1/auth, /v1/identity, /v1/family, /v1/organization, /v1/api-keys, /v1/content, /v1/directory, /v1/places, /v1/travel, /v1/events, /v1/applications, /v1/ubuntu, /v1/pipeline, /v1/admin, /v1/search, /v1/media, /v1/couch, /v1/dashboard | nyuchi_platform_db | Identity, multi-tenancy, places, events, content, business directory, admin |
/v1/commerce | mukoko_bushtrade_db | Products, offers, businesses, inquiries, scam reports |
/v1/pay/wallet, /v1/pay/tokens, /v1/pay/gateway | nyuchi_pay_db | Wallets, token lifecycle, fiat on/off-ramps |
/v1/logistics | nyuchi_logistics_db | Vehicles, bookings, drivers, locations |
/v1/lingo | mukoko_lingo_db | Phrases, languages, study sessions, XP, progress |
/v1/news | mukoko_news_db | Articles, journalists, organisations, engagement |
/v1/weather | (reserved) | Placeholder until a weather backend is selected |
Authentication
Every protected endpoint accepts the same platform JWT. Obtain a token from the Stytch-backed auth pipeline at/v1/auth/*, then send it on subsequent requests.
get_optional_user) and return public data; mutating endpoints require an authenticated caller (get_current_user).
Configuration status
GET / reports the gateway version and whether each product database is wired up. Use it to confirm what the deployed environment can serve.
false entry means the gateway has no credentials for that database. Routers in that namespace return HTTP 503 at request time so the rest of the gateway keeps working.
The pay namespace is configured but its schema is not yet provisioned. Endpoints that read or write data return HTTP 501 until the schema is deployed. Status endpoints under
/v1/pay/status and the gateway root remain available.Configuring product databases
The gateway reads one environment-variable triplet per database. Set them as Fly secrets before deploying.Error handling
| Status | Meaning |
|---|---|
401 Unauthorized | Missing or invalid platform JWT on a protected endpoint. |
404 Not Found | Resource does not exist in the namespace’s database. |
501 Not Implemented | Endpoint exists but its underlying schema is not provisioned (currently /v1/pay/* and /v1/weather/forecast). |
503 Service Unavailable | The product database for this namespace is not configured in the running environment. |
Next steps
- Commerce API — BushTrade product, business, and inquiry endpoints.
- Pay API — wallet, token, and gateway sub-namespaces.
- Logistics API — vehicle bookings.
- Lingo API — language learning surface.
- News API — articles and engagement actions.
- Weather API — reserved namespace.