Visão geral da API

A API do Claude é uma API RESTful em https://api.anthropic.com que fornece acesso programático aos modelos Claude e aos Claude Managed Agents.



Pré-requisitos

Para usar a API do Claude, você precisará de:

• Uma conta no Claude Console
• Uma chave de API, ou uma regra de Workload Identity Federation configurada

Para instruções de configuração passo a passo, consulte Primeiros passos.



APIs disponíveis

A API do Claude inclui as seguintes APIs:

Disponibilidade Geral:

• Messages API: Envie mensagens ao Claude para interações conversacionais (POST /v1/messages)
• Message Batches API: Processe grandes volumes de requisições de Messages de forma assíncrona com redução de custo de 50% (POST /v1/messages/batches)
• Token Counting API: Conte tokens em uma mensagem antes de enviá-la para gerenciar custos e limites de taxa (POST /v1/messages/count_tokens)
• Models API: Liste os modelos Claude disponíveis e seus detalhes (GET /v1/models)

Beta:

• Files API: Faça upload e gerencie arquivos para uso em várias chamadas de API (POST /v1/files, GET /v1/files)
• Skills API: Crie e gerencie habilidades personalizadas de agentes (POST /v1/skills, GET /v1/skills)
• Agents API: Defina configurações de agentes reutilizáveis e versionadas para Claude Managed Agents (POST /v1/agents, GET /v1/agents)
• Sessions API: Execute sessões de agentes com estado em sandboxes gerenciados na nuvem (POST /v1/sessions, GET /v1/sessions/{id}/events/stream)
• Environments API: Configure templates de sandbox para sessões de agentes (POST /v1/environments, GET /v1/environments)

Para a referência completa da API com todos os endpoints, parâmetros e esquemas de resposta, explore as páginas de referência da API listadas na navegação. Para acessar recursos beta, consulte Cabeçalhos beta.



Autenticação

Para detalhes sobre ambos os métodos de autenticação e quando usar cada um, consulte Autenticação. Todas as requisições à API do Claude devem incluir estes cabeçalhos:

Se você estiver usando os SDKs de cliente, o SDK enviará esses cabeçalhos automaticamente. Para detalhes sobre versionamento da API, consulte Versões da API.

Ao acessar o Claude através de uma plataforma de nuvem, a autenticação é integrada ao sistema IAM do provedor de nuvem. Consulte a documentação específica da plataforma para tipos de credenciais suportados, cabeçalhos obrigatórios e opções de autenticação.



Obtendo chaves de API

A API é disponibilizada através do Console web. Você pode usar o Workbench para experimentar a API no navegador e depois gerar chaves de API em Configurações da Conta. Você escolhe a expiração de cada chave ao criá-la. Use workspaces para segmentar suas chaves de API e controlar gastos por caso de uso.



SDKs de cliente

A Anthropic fornece SDKs oficiais que simplificam a integração com a API ao lidar com autenticação, formatação de requisições, tratamento de erros e muito mais.

Benefícios:

• Gerenciamento automático de cabeçalhos (x-api-key, anthropic-version, content-type)
• Tratamento de requisições e respostas com segurança de tipos
• Lógica de retry e tratamento de erros integrados
• Suporte a streaming
• Timeouts de requisição e gerenciamento de conexão

Para uma lista de SDKs de cliente, consulte SDKs de cliente.



API do Claude vs plataformas de nuvem

O Claude está disponível através da API direta do Claude e através de plataformas de nuvem. Escolha com base em sua infraestrutura, disponibilidade de recursos, requisitos de conformidade e preferências de preço.



API do Claude

• Acesso direto aos modelos e recursos mais recentes
• Faturamento e suporte da Anthropic
• Ideal para: Novas integrações, acesso completo a recursos, relacionamento direto com a Anthropic



APIs de plataformas de nuvem

Acesse o Claude através da AWS, Google Cloud ou Microsoft Azure:

• Integrado com faturamento e IAM do provedor de nuvem
• A disponibilidade de recursos varia por plataforma: Plataformas operadas pela Anthropic incluem Claude Platform on AWS e Microsoft Foundry; plataformas operadas por parceiros incluem Amazon Bedrock e Google Cloud. Consulte a página de cada plataforma para disponibilidade e cronograma de recursos.
• Ideal para: Compromissos existentes com nuvem, requisitos específicos de conformidade, faturamento consolidado na nuvem



Formato de requisição e resposta



Limites de tamanho de requisição

Se você exceder esses limites, receberá um erro 413 request_too_large.



Cabeçalhos de resposta

A API do Claude inclui os seguintes cabeçalhos em cada resposta:

• request-id: Um identificador globalmente único para a requisição
• anthropic-organization-id: O ID da organização associado à chave de API usada na requisição



Paginação

Endpoints de listagem retornam resultados em páginas. A maioria dos endpoints de listagem mais recentes usa o esquema de cursor page e next_page descrito nesta seção. Alguns usam um esquema diferente; consulte a nota no final desta seção. Use o parâmetro de query limit para controlar o tamanho da página e o parâmetro de query page para buscar uma página adjacente. Cada resposta inclui um array data junto com campos de cursor para navegar entre páginas.

Para voltar uma página, passe prev_page como o parâmetro page. prev_page é null quando você está na primeira página. Nem todos os endpoints de listagem suportam prev_page. Apenas GET /v1/sessions retorna prev_page; em endpoints de listagem que não suportam paginação reversa, o campo está ausente da resposta em vez de ser null. Para um passo a passo de requisição, consulte Listando sessões.

Cada SDK fornece um iterador de paginação automática que segue next_page para você. Em Python e TypeScript, você o obtém iterando diretamente o resultado da listagem. Os outros SDKs fornecem o iterador através de um método separado. A paginação automática do SDK é apenas para frente; para voltar uma página, leia prev_page da resposta e passe-o de volta como o parâmetro page você mesmo. Consulte SDKs de cliente para detalhes específicos de cada linguagem.



Limites de taxa e disponibilidade



Limites de taxa

A API aplica "rate limits" (limites de taxa) e limites de gastos para prevenir uso indevido e gerenciar capacidade. Os limites são organizados em níveis de uso; sua organização é colocada em um nível automaticamente e pode passar para um nível superior ao longo do tempo. Cada nível tem:

• Limites de gastos: Custo mensal máximo para uso da API
• Limites de taxa: Número máximo de requisições por minuto (RPM) e tokens por minuto (TPM)

Você pode visualizar seus limites de taxa na página Limites de taxa e seus limites de gastos na página Faturamento no Console. Para limites de taxa mais altos ou um teto de gastos mensal maior, use Request rate limit increase na página de Limites de taxa.

Para informações detalhadas sobre limites, níveis e o algoritmo de token bucket usado para limitação de taxa, consulte Limites de taxa.



Disponibilidade

A API do Claude está disponível em muitos países e regiões ao redor do mundo. Verifique a página de regiões suportadas para confirmar a disponibilidade em sua localização.



Próximos passos