Inicio / Documentación / Descripción general de la API

Descripción general de la API

Todos los endpoints que expone la pasarela, qué formato utiliza cada uno y qué devuelve.

Tres endpoints. Dos formatos de solicitud. Una clave.

MétodoRutaFormatoPropósito
POST/v1/messagesMessages de AnthropicCompletado de chat, estructura envolvente de Anthropic
POST/v1/chat/completionsOpenAI Chat CompletionsGeneración de respuestas de chat, estructura de OpenAI
GET/v1/modelsLista al estilo de OpenAIIdentificadores de modelos a los que puede llamar tu clave

Se publica una descripción legible por máquinas en /openapi.json, y un resumen en texto plano de todo el sitio en /llms.txt y /llms-full.txt.

Elegir un endpoint

Dan acceso a los mismos modelos al mismo precio. Elige según el formato que ya genere tu cliente; no conviertas los formatos por tu cuenta.

EndpointCabecera de autenticaciónEstructura de la respuestaTransmisión en tiempo real
/v1/messagesx-api-key o Bearercontent[] array + usageSSE, content_block_delta eventos
/v1/chat/completionsBearerchoices[].message.contentSSE, choices[].delta.content fragmentos
Las estructuras de streaming difieren y no son intercambiables. Un cliente escrito para choices[].delta.content no leerá nada de un flujo de Messages. Consulta Transmisión en tiempo real.

Cabeceras comunes

CabeceraSe aplica aNotas
content-type: application/jsonambas solicitudes POSTObligatorio
x-api-keyMessagesEstilo de Anthropic
Authorization: BearerambosEstilo de OpenAI; también lo acepta Messages
anthropic-version: 2023-06-01MessagesLos SDK de Anthropic la establecen automáticamente
accept: text/event-streamambosLos SDK la establecen cuando stream es true