Docs / API Reference
GlobalRouter API Reference
This section covers only the GlobalRouter primary API under /api/v1. Each category page lists endpoints, with individual endpoint details on child pages.
Scenario-oriented API docs
| Category | Page | Description |
|---|
| Models | /docs/reference/models | Model lists, filters, and model endpoints. |
| Providers | /docs/reference/providers | Public provider lists and availability boundaries. |
| Chat | /docs/reference/chat | Chat completions, streaming, tools, structured outputs, chat image output, and chat video output. |
| Text | /docs/reference/text | Responses, Messages, and Embeddings. |
| Audio | /docs/reference/audio | Text-to-speech and audio transcription. |
| Images | /docs/reference/images | Image creation, reference images, and response formats. |
| Videos | /docs/reference/videos | Video task creation, querying, content retrieval, and model lists. |
| Assets | /docs/reference/files | Asset groups, imports, lists, updates, deletes, and refreshes. |
| Credits | /docs/reference/credits | Balance, usage, and credit composition. |
| API keys | /docs/reference/api-keys | API key lookup, creation, updates, and revocation. |
Platform APIs
| Method | Endpoint | Description |
|---|
| GET | GET /api/v1/credits | Query current tenant credits. |
| GET | GET /api/v1/generation | Query metadata by request or generation record. |
| GET | GET /api/v1/generation/content | Read generated content for a generation record. |
Reading recommendations
- Start with Quick start to confirm the API surface, then open the matching API category.
- Each category page lists endpoints. Click an endpoint to open its dedicated reference page.
- Endpoint pages show parameter reference, curl examples, and response examples on desktop; mobile keeps the endpoint list only.