La Claude API es una API RESTful en https://api.anthropic.com que proporciona acceso programático a los modelos Claude y a Claude Managed Agents.
Para usar la Claude API, necesitarás:
Para instrucciones de configuración paso a paso, consulta Primeros pasos.
La Claude API incluye las siguientes API:
POST /v1/messages)POST /v1/messages/batches)POST /v1/messages/count_tokens)GET /v1/models)POST /v1/files, GET /v1/files)POST /v1/skills, GET /v1/skills)Las siguientes API están en beta:
POST /v1/agents, GET /v1/agents)POST /v1/sessions, GET /v1/sessions/{id}/events/stream)POST /v1/environments, GET /v1/environments)Para la referencia completa de la API con todos los endpoints, parámetros y esquemas de respuesta, explora las páginas de referencia de la API que aparecen en la navegación. Para acceder a las funciones beta, consulta Encabezados beta.
Para obtener detalles sobre ambos métodos de autenticación y cuándo usar cada uno, consulta Autenticación. Todas las solicitudes a la Claude API deben incluir estos encabezados:
| Encabezado | Valor | Obligatorio |
|---|---|---|
x-api-key | Tu clave de API de la Console | Uno de x-api-key o Authorization |
Authorization | Bearer <token>, donde <token> es un token de acceso de corta duración obtenido de POST /v1/oauth/token mediante Workload Identity Federation | Uno de x-api-key o Authorization |
anthropic-version | Versión de la API (por ejemplo, 2023-06-01) | Sí |
content-type | application/json | Sí |
Si estás usando los SDK de cliente, el SDK enviará estos encabezados automáticamente. Para detalles sobre el versionado de la API, consulta Versiones de la API.
Al acceder a Claude a través de una plataforma en la nube, la autenticación se integra con el sistema IAM del proveedor de nube. Consulta la documentación específica de cada plataforma para conocer los tipos de credenciales admitidos, los encabezados obligatorios y las opciones de autenticación.
La API está disponible a través de la Console web. Puedes usar Playground para probar la API en el navegador y luego generar claves de API en la Configuración de la cuenta. Tú eliges la expiración de cada clave cuando la creas. Usa workspaces (espacios de trabajo) para segmentar tus claves de API y controlar el gasto por caso de uso.
Anthropic proporciona SDK oficiales que simplifican la integración con la API al encargarse de la autenticación, el formato de las solicitudes, el manejo de errores y más.
Beneficios:
x-api-key, anthropic-version, content-type)Para ver una lista de los SDK de cliente, consulta SDK de cliente.
Claude está disponible a través de la Claude API directa y a través de plataformas en la nube. Elige según tu infraestructura, la disponibilidad de funciones, los requisitos de cumplimiento y tus preferencias de precios.
Accede a Claude a través de AWS, Google Cloud o Microsoft Azure:
| Plataforma | Proveedor | Documentación |
|---|---|---|
| Agent Platform | Google Cloud | Claude en Google Cloud |
| Amazon Bedrock | AWS | Claude en Amazon Bedrock |
| Claude Platform on AWS | AWS (operado por Anthropic) | Claude Platform on AWS |
| Microsoft Foundry | Microsoft Azure (operado por Anthropic) | Claude en Microsoft Foundry |
| Endpoint | Tamaño máximo de solicitud |
|---|---|
| Messages, Token Counting | 32 MB |
| Message Batches API | 256 MB |
| Files API | 500 MB |
| Sessions, Agents, Environments | 32 MB |
Si superas estos límites, recibirás un error 413 request_too_large.
La Claude API incluye los siguientes encabezados en sus respuestas:
| Encabezado | Descripción |
|---|---|
request-id | Un identificador globalmente único para la solicitud, como req_018EeWyXxfu5pfWkrYcMdjWG. Inclúyelo cuando contactes al soporte sobre una solicitud específica. Consulta ID de solicitud. |
anthropic-organization-id | El ID de la organización a la que pertenece la clave de API o el token de acceso usado en la solicitud. |
anthropic-workspace-id | El ID con prefijo wrkspc_ del workspace al que se resolvió la clave de API o el token de acceso, como wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ, incluso cuando se trata del Default Workspace de tu organización. Está ausente cuando la credencial no se resuelve a un workspace (por ejemplo, en solicitudes a la Admin API) o cuando la solicitud falla antes de que se complete la autenticación. Consulta Identificar el workspace detrás de una respuesta de la API. |
Para los encabezados de límite de velocidad, consulta Encabezados de respuesta en Límites de velocidad. Para ver ejemplos que leen un encabezado de respuesta por nombre con cada SDK, consulta Identificar el workspace detrás de una respuesta de la API.
Los endpoints de listado devuelven resultados en páginas. La mayoría de los endpoints de listado más recientes usan el esquema de cursores page y next_page descrito en esta sección. Algunos usan un esquema diferente; consulta la nota al final de esta sección. Usa el parámetro de consulta limit para controlar el tamaño de página y el parámetro de consulta page para obtener una página adyacente. Cada respuesta incluye un arreglo data junto con campos de cursor para navegar entre páginas.
| Nombre | Ubicación | Descripción |
|---|---|---|
limit | Parámetro de consulta | Número máximo de elementos a devolver por página. |
page | Parámetro de consulta | Cursor opaco de una respuesta anterior. Pasa aquí un valor de next_page o prev_page para obtener la página adyacente. |
order | Parámetro de consulta | Dirección de ordenamiento de los resultados (asc o desc), en los endpoints de listado que admiten ordenamiento. Un cursor page solo es válido con el order con el que se creó. |
next_page | Campo de respuesta | Cursor para la página siguiente, o null si no hay más resultados. |
prev_page | Campo de respuesta | Cursor para la página anterior en los endpoints que admiten paginación hacia atrás (actualmente GET /v1/sessions), o null si estás en la primera página. Los demás endpoints de listado omiten el campo. |
Para retroceder una página, pasa prev_page como el parámetro page. prev_page es null cuando estás en la primera página. No todos los endpoints de listado admiten prev_page. Solo GET /v1/sessions devuelve prev_page; en los endpoints de listado que no admiten paginación hacia atrás, el campo está ausente de la respuesta en lugar de ser null. Para ver un recorrido de una solicitud, consulta Listar sesiones.
Cada SDK proporciona un iterador con paginación automática que sigue next_page por ti. En Python y TypeScript, lo obtienes iterando directamente el resultado del listado. Los demás SDK proporcionan el iterador a través de un método separado. La paginación automática de los SDK es solo hacia adelante; para retroceder una página, lee prev_page de la respuesta y pásalo tú mismo como el parámetro page. Consulta SDK de cliente para detalles específicos de cada lenguaje.
La API aplica "rate limits" (límites de velocidad) y límites de gasto para prevenir el uso indebido y gestionar la capacidad. Los límites se organizan en niveles de uso; tu organización se asigna a un nivel automáticamente y puede pasar a un nivel superior con el tiempo. Cada nivel tiene:
Puedes ver tus límites de velocidad en la página Límites de velocidad y tus límites de gasto en la página Facturación de la Console. Para obtener límites de velocidad más altos o un tope de gasto mensual mayor, usa Request rate limit increase (Solicitar aumento del límite de velocidad) en la página Límites de velocidad.
Para información detallada sobre los límites, los niveles y el algoritmo de token bucket usado para limitar la velocidad, consulta Límites de velocidad.
La Claude API está disponible en muchos países y regiones de todo el mundo. Revisa la página de regiones admitidas para confirmar la disponibilidad en tu ubicación.
Especificación completa de la API para interacciones directas con los modelos
Endpoints de Agents, Sessions y Environments
Python, TypeScript, C#, Go, Java, PHP y Ruby
Niveles de uso, solicitud de límites más altos y el algoritmo de token bucket
Was this page helpful?