Referencia de la APIUso de la API

Descripción general de la API

Copy page



Comprende los endpoints disponibles de la Claude API, los encabezados de autenticación, los SDK de cliente, la paginación, los límites de velocidad y las opciones de acceso a través de plataformas en la nube.

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.

Requisitos previos

Para usar la Claude API, necesitarás:

• Una cuenta de Claude Console
• Una clave de API, o una regla configurada de Workload Identity Federation

Para instrucciones de configuración paso a paso, consulta Primeros pasos.

API disponibles

La Claude API incluye las siguientes API:

• Messages API: Envía mensajes a Claude para interacciones conversacionales (POST /v1/messages)
• Message Batches API: Procesa grandes volúmenes de solicitudes de Messages de forma asíncrona con una reducción de costos del 50% (POST /v1/messages/batches)
• Token Counting API: Cuenta los tokens de un mensaje antes de enviarlo para gestionar costos y límites de velocidad (POST /v1/messages/count_tokens)
• Models API: Lista los modelos Claude disponibles y sus detalles (GET /v1/models)
• Files API: Sube y administra archivos para usarlos en múltiples llamadas a la API (POST /v1/files, GET /v1/files)
• Skills API: Crea y administra skills de agente personalizadas (POST /v1/skills, GET /v1/skills)

Las siguientes API están en beta:

• Agents API: Define configuraciones de agentes reutilizables y versionadas para Claude Managed Agents (POST /v1/agents, GET /v1/agents)
• Sessions API: Ejecuta sesiones de agente con estado en sandboxes administrados en la nube (POST /v1/sessions, GET /v1/sessions/{id}/events/stream)
• Environments API: Configura plantillas de sandbox para sesiones de agente (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.

Autenticación

Para obtener detalles sobre cada método de autenticación y cuándo usarlo, consulta Autenticación. Las solicitudes a la Claude API incluyen estos encabezados:

Si usas los SDK de cliente, el SDK envía automáticamente los encabezados de autenticación, versión y content-type; tú mismo pasas anthropic-workspace-id cuando tu clave lo necesita. Para obtener 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.

Obtener claves de API

La API está disponible a través de la Console web. Puedes usar el playground para probar la API en el navegador y luego generar claves de API en la Configuración de la cuenta (consulta Obtén tu clave de API de Claude). Eliges el tipo de cada clave (consulta Tipos de clave) y su vencimiento al crearla. Usa workspaces para separar entornos y controlar el gasto por caso de uso.

SDK de cliente

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:

• Gestión automática de encabezados (autenticación, anthropic-version, content-type)
• Manejo de solicitudes y respuestas con seguridad de tipos
• Lógica de reintentos y manejo de errores integrados
• Soporte para streaming
• Tiempos de espera de solicitudes y gestión de conexiones

Para ver una lista de los SDK de cliente, consulta SDK de cliente.

Claude API vs. plataformas en la nube

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.

Claude API

• Acceso directo a los modelos y funciones más recientes
• Facturación y soporte de Anthropic
• Ideal para: Nuevas integraciones, acceso completo a funciones, relación directa con Anthropic

API de plataformas en la nube

Accede a Claude a través de AWS, Google Cloud o Microsoft Azure:

• Integrado con la facturación y el IAM del proveedor de nube
• La disponibilidad de funciones varía según la plataforma: Las plataformas operadas por Anthropic incluyen Claude Platform on AWS y Microsoft Foundry; las plataformas operadas por socios incluyen Amazon Bedrock y Google Cloud. Consulta la página de cada plataforma para conocer la disponibilidad de funciones y los plazos.
• Ideal para: Compromisos existentes con la nube, requisitos de cumplimiento específicos, facturación consolidada en la nube

Formato de solicitud y respuesta

Límites de tamaño de solicitud

Si superas estos límites, recibirás un error 413 request_too_large.

Encabezados de respuesta

La Claude API incluye los siguientes encabezados en sus respuestas:

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.

Paginación

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.

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 obtener detalles específicos de cada lenguaje.

Límites de velocidad y disponibilidad

Límites de velocidad

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 ubica en un nivel automáticamente y puede pasar a un nivel superior con el tiempo. Cada nivel tiene:

• Límites de gasto: Costo mensual máximo por el uso de la API
• Límites de velocidad: Número máximo de solicitudes por minuto (RPM) y tokens por minuto (TPM)

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 en la página de Límites de velocidad.

Para obtener 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.

Disponibilidad

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.

Próximos pasos