Início / Documentação / Visão geral da API

Visão geral da API

Todos os endpoints que o gateway expõe, o formato que cada um usa e o que retorna.

Três endpoints. Dois formatos de requisição. Uma chave.

MétodoCaminhoFormatoFinalidade
POST/v1/messagesAnthropic MessagesConclusão de chat, envelope Anthropic
POST/v1/chat/completionsOpenAI Chat CompletionsConclusão de chat, envelope OpenAI
GET/v1/modelsLista no estilo OpenAIIDs de modelos que sua chave pode acessar

Uma descrição legível por máquina está publicada em /openapi.json, e um resumo de todo o site em texto simples está em /llms.txt e /llms-full.txt.

Escolher um endpoint

Eles dão acesso aos mesmos modelos pelo mesmo preço. Escolha conforme o formato que seu cliente já envia — não converta os formatos por conta própria.

EndpointCabeçalho de autenticaçãoEstrutura da respostaTransmissão
/v1/messagesx-api-key ou Bearercontent[] array + usageSSE, content_block_delta eventos
/v1/chat/completionsBearerchoices[].message.contentSSE, choices[].delta.content fragmentos
As estruturas de streaming diferem e não são intercambiáveis. Um cliente desenvolvido para choices[].delta.content não conseguirá ler nada de um fluxo de Messages. Consulte Transmissão.

Cabeçalhos comuns

CabeçalhoAplica-se aObservações
content-type: application/jsonambos os POSTsObrigatório
x-api-keyMessagesEstilo Anthropic
Authorization: BearerambosEstilo OpenAI; também aceito por Messages
anthropic-version: 2023-06-01MessagesDefinido automaticamente pelos SDKs da Anthropic
accept: text/event-streamambosDefinido pelos SDKs quando stream é true