Índice de endpoints REST
Este índice cobre recursos REST para clientes. Todas as rotas exigem autenticação, exceto quando marcadas públicas. Mutações de projeto exigem o proprietário; acesso compartilhado/público é resolvido no alias OpenAI.
Versionamento
A primeira versão v1 fixa o contrato atual. As mudanças posteriores na v1 são aditivas; mudanças incompatíveis exigem uma nova versão principal.
A API REST é versionada no caminho: toda rota começa com /api/v1/. Dentro da
v1, as mudanças são apenas aditivas: novos endpoints, novos campos opcionais de
requisição, novos campos de resposta. O que quebraria uma integração sai como
uma nova versão principal, que roda junto com a v1 antes de a v1 ser
encerrada. Clientes devem ignorar campos de resposta que não conhecem.
As rotas compatíveis com a OpenAI têm sua própria versão,
/api/projects/{owner}/{project}/openai/v1/..., e seguem o formato da API da
OpenAI. Um caminho encerrado responde 410 Gone com o código de erro
api_version_required, o caminho sucessor em detail.successor e um
cabeçalho Link: <sucessor>; rel="successor-version".
| Recurso | Endpoints |
|---|---|
| Conta | GET /api/v1/me, PATCH /api/v1/me/profile, POST /api/v1/me/password |
| Chaves | `GET |
| Projetos | `GET |
| Chats | `GET |
| Imports | limites, criar, upload, profile, preview, confirmar, listar, detalhe e cancelar |
| Feedback de busca | POST .../api/v1/projects/{owner}/{project}/datasets/{id}/retrieval-events (e /batch), listar/detalhe, ignorar/restaurar, promover e o GET .../retrieval-settings somente leitura — veja Feedback de busca |
| Treino | listar/criar jobs, detalhe, cancelar, retry, estimativa de retry, dataset congelado, tentativas, logs e download LoRA |
| Modelos | listar/criar aliases, atualizar, ativar, desativar e gerenciar shares |
| Inferência | OpenAI por projeto: GET /v1/models, POST /v1/chat/completions, POST /v1/completions e POST /v1/embeddings |
| Preços | Públicos /api/v1/pricing/platform, /api/v1/pricing/models e /api/v1/pricing/estimate |
| Créditos | saldo, uso, checkout e status do checkout |
| Conta inteira | GET /api/v1/models, GET /api/v1/dashboard, GET /api/v1/activity |
Referência completa
A referência da API documenta cada rota: parâmetros, corpo da requisição, cada corpo de resposta e o corpo de erro, com exemplos de requisição. O mesmo contrato pode ser baixado como documento OpenAPI 3.1, em português e inglês, para geradores de código e agentes. O índice Markdown de operações tem um arquivo independente por endpoint, com seus schemas. Estes guias continuam sendo a fonte para ciclo de vida, cobrança, paginação e retries que um schema sozinho não expressa. Só as rotas de clientes são publicadas; rotas de operação e internas não fazem parte da API.
Nas listas de conjuntos de dados, versões e índices de Search, os cursores pertencem ao projeto. Nos exemplos, pertencem ao conjunto de dados e à busca textual. No registro global de modelos, pertencem à conta e aos filtros; na atividade, à conta e ao filtro de arquivamento. Mantenha esses escopos ao seguir next_cursor; reinicie pela primeira página após alterá-los. Reutilizar um desses cursores de outro escopo retorna 400 invalid_cursor.