REST endpoint index
This index covers customer-facing REST resources. All routes are authenticated unless marked public. Project mutations are owner-only; shared/public model access is resolved on the OpenAI-compatible alias route.
Versioning
The first v1 release freezes the current contract. Subsequent changes within v1 are additive; breaking changes require a new major version.
The REST API is versioned in the path: every route starts with /api/v1/.
Within v1, changes are additive only: new endpoints, new optional request
fields, new response fields. Anything that would break an integration ships
as a new major version, which runs alongside v1 before v1 is retired. Clients
should ignore response fields they do not know.
The OpenAI-compatible routes carry their own version,
/api/projects/{owner}/{project}/openai/v1/..., and follow the OpenAI API
shape. A retired path answers 410 Gone with the error code
api_version_required, the successor path in detail.successor, and a
Link: <successor>; rel="successor-version" header.
| Resource | Endpoints |
|---|---|
| Account | GET /api/v1/me, PATCH /api/v1/me/profile, POST /api/v1/me/password |
| API keys | `GET |
| Projects | `GET |
| Chats | `GET |
| Imports | GET .../datasets/limits, create/upload/profile/preview/confirm/list/detail/cancel under the project import routes |
| Search feedback | POST .../api/v1/projects/{owner}/{project}/datasets/{id}/retrieval-events (and /batch), GET list/detail, PATCH skip/restore, POST .../promote, and read-only GET .../retrieval-settings — see Search feedback |
| Training | `GET |
| Hosted models | `GET |
| Inference | Project-scoped OpenAI GET /v1/models, POST /v1/chat/completions, POST /v1/completions, and POST /v1/embeddings |
| Pricing | Public GET /api/v1/pricing/platform, GET /api/v1/pricing/models, POST /api/v1/pricing/estimate |
| Credits | GET /api/v1/credits, GET /api/v1/credits/usage, checkout and checkout status |
| Account-wide | GET /api/v1/models, GET /api/v1/dashboard, GET /api/v1/activity |
Full reference
The API reference documents every route: its parameters, request body, every response body and the error body, with request examples. The same contract is downloadable as an OpenAPI 3.1 document, in English and Portuguese, for code generators and agents. Agents can also start at the Markdown operation index, which links one standalone file per endpoint and includes its schemas. These guides remain the source for lifecycle, billing, pagination and retry semantics that a schema alone cannot express. Only customer routes are published; operator and internal routes are not part of the API.
For Search datasets, versions and indexes, cursors belong to the project. Example cursors belong to the dataset and text search. Global model registry cursors belong to the account and registry filters; activity cursors belong to the account and archive filter. Keep these scopes when following next_cursor; restart from the first page after changing them. Reusing one of these cursors from another scope returns 400 invalid_cursor.