---
title: Visão geral da API
url: https://platform.claude.com/docs/pt-BR/api/overview
description: Entenda os endpoints disponíveis da Claude API, cabeçalhos de autenticação, SDKs de cliente, paginação, limites de taxa e opções de acesso a plataformas de nuvem.
---
A Claude API é uma API RESTful em `https://api.anthropic.com` que fornece acesso programático aos modelos Claude e aos Claude Managed Agents.
**Novo no Claude?** Para acesso direto ao modelo, comece com [Get started](https://platform.claude.com/docs/pt-BR/get-started) e [Working with Messages](https://platform.claude.com/docs/pt-BR/build-with-claude/working-with-messages). Para infraestrutura de agentes gerenciados, consulte o [quickstart dos Claude Managed Agents](https://platform.claude.com/docs/pt-BR/managed-agents/quickstart).
## Pré-requisitos
Para usar a Claude API, você precisará de:
* Uma [conta do Claude Console](https://platform.claude.com)
* Uma [chave de API](https://platform.claude.com/settings/keys) do Console, ou uma regra de [Workload Identity Federation](https://platform.claude.com/docs/pt-BR/manage-claude/workload-identity-federation) configurada
Para instruções de configuração passo a passo, consulte [Get started](https://platform.claude.com/docs/pt-BR/get-started).
## APIs disponíveis
A Claude API inclui as seguintes APIs:
* **[Messages API](https://platform.claude.com/docs/pt-BR/api/messages/create)**: Envie mensagens ao Claude para interações conversacionais (`POST /v1/messages`)
* **[Message Batches API](https://platform.claude.com/docs/pt-BR/api/messages/batches/create)**: 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](https://platform.claude.com/docs/pt-BR/api/messages/count_tokens)**: Conte tokens em uma mensagem antes de enviar para gerenciar custos e limites de taxa (`POST /v1/messages/count_tokens`)
* **[Models API](https://platform.claude.com/docs/pt-BR/api/models/list)**: Liste os modelos Claude disponíveis e seus detalhes (`GET /v1/models`)
* **[Files API](https://platform.claude.com/docs/pt-BR/api/files/upload)**: Faça upload e gerencie arquivos para uso em várias chamadas de API (`POST /v1/files`, `GET /v1/files`)
* **[Skills API](https://platform.claude.com/docs/pt-BR/api/skills/create)**: Crie e gerencie habilidades de agente personalizadas (`POST /v1/skills`, `GET /v1/skills`)
As seguintes APIs estão em beta:
* **[Agents API](https://platform.claude.com/docs/pt-BR/managed-agents/agent-setup)**: Defina configurações de agente reutilizáveis e versionadas para os Claude Managed Agents (`POST /v1/agents`, `GET /v1/agents`)
* **[Sessions API](https://platform.claude.com/docs/pt-BR/managed-agents/sessions)**: Execute sessões de agente com estado em sandboxes de nuvem gerenciados (`POST /v1/sessions`, `GET /v1/sessions/{id}/events/stream`)
* **[Environments API](https://platform.claude.com/docs/pt-BR/managed-agents/environments)**: Configure templates de sandbox para sessões de agente (`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 [Beta headers](https://platform.claude.com/docs/pt-BR/api/beta-headers).
## Autenticação
Para detalhes sobre cada método de autenticação e quando usá-lo, consulte [Authentication](https://platform.claude.com/docs/pt-BR/manage-claude/authentication). As requisições à Claude API incluem estes cabeçalhos:
| Cabeçalho | Valor | Obrigatório |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Authorization` | `Bearer `, em que `` é sua chave de API ou um token de acesso de curta duração obtido de `POST /v1/oauth/token` por meio do [Workload Identity Federation](https://platform.claude.com/docs/pt-BR/manage-claude/workload-identity-federation) | Sim, a menos que `x-api-key` esteja definido |
| `x-api-key` | Sua chave de API do Console. Alternativa legada ao `Authorization`, ainda suportada | Não |
| `anthropic-workspace-id` | ID do [workspace](https://platform.claude.com/docs/pt-BR/manage-claude/workspaces) em que a requisição é executada (por exemplo, `wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ`). Consulte [Selecionar um workspace](https://platform.claude.com/docs/pt-BR/manage-claude/authentication#select-a-workspace). | Obrigatório com uma chave de API de múltiplos workspaces. Opcional para outras chaves de API. Uma chave criada para um único workspace é executada nesse workspace quando você omite o cabeçalho. Não é usado com tokens do Workload Identity Federation, que selecionam um workspace na troca de token. |
| `anthropic-version` | Versão da API (por exemplo, `2023-06-01`) | Sim |
| `content-type` | `application/json` | Sim |
Se você estiver usando os [SDKs de cliente](https://platform.claude.com/docs/pt-BR/api/overview#client-sdks), o SDK envia os cabeçalhos de autenticação, versão e content-type automaticamente; você passa `anthropic-workspace-id` por conta própria quando sua chave precisa dele. Para detalhes sobre versionamento da API, consulte [API versions](https://platform.claude.com/docs/pt-BR/api/versioning).
Ao acessar o Claude através de uma [plataforma de nuvem](https://platform.claude.com/docs/pt-BR/api/overview#claude-api-vs-cloud-platforms), 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 por meio do [Console](https://platform.claude.com/) web. No Console, você pode usar o [playground](https://platform.claude.com/playground) (`platform.claude.com/playground`) para experimentar a API no navegador e depois gerar chaves de API na página [Chaves de API](https://platform.claude.com/settings/keys) (`platform.claude.com/settings/keys`). Para saber como, consulte [Obtenha sua chave de API do Claude](https://platform.claude.com/docs/pt-BR/get-api-key). Você escolhe o tipo de cada chave (consulte [Tipos de chave](https://platform.claude.com/docs/pt-BR/manage-claude/authentication#key-types)) e sua [expiração](https://platform.claude.com/docs/pt-BR/manage-claude/authentication#key-expiration) ao criá-la. Use [workspaces](https://platform.claude.com/settings/workspaces) no Console para separar ambientes e [controlar gastos](https://platform.claude.com/docs/pt-BR/api/rate-limits) 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 (autenticação, `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 [Client SDKs](https://platform.claude.com/docs/pt-BR/cli-sdks-libraries/overview).
## Claude API vs plataformas de nuvem
O Claude está disponível através da Claude API direta 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.
### Claude API
* **Acesso direto** aos modelos e recursos mais recentes
* **Cobrança e suporte da Anthropic**
* **Melhor para:** Novas integrações, acesso completo a recursos, relacionamento direto com a Anthropic
### APIs de plataformas de nuvem
Acesse o Claude através de AWS, Google Cloud ou Microsoft Azure:
* **Integrado** com a cobrança e o IAM do provedor de nuvem
* **A disponibilidade de recursos varia por plataforma:** As plataformas operadas pela Anthropic incluem [Claude Platform on AWS](https://platform.claude.com/docs/pt-BR/build-with-claude/claude-platform-on-aws) e [Microsoft Foundry](https://platform.claude.com/docs/pt-BR/build-with-claude/claude-in-microsoft-foundry); as plataformas operadas por parceiros incluem Amazon Bedrock e Google Cloud. Consulte a página de cada plataforma para disponibilidade de recursos e prazos.
* **Melhor para:** Compromissos de nuvem existentes, requisitos específicos de conformidade, cobrança de nuvem consolidada
| Plataforma | Provedor | Documentação |
| ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| Agent Platform | Google Cloud | [Claude no Google Cloud](https://platform.claude.com/docs/pt-BR/build-with-claude/claude-on-vertex-ai) |
| Amazon Bedrock | AWS | [Claude no Amazon Bedrock](https://platform.claude.com/docs/pt-BR/build-with-claude/claude-in-amazon-bedrock) |
| Claude Platform on AWS | AWS (operado pela Anthropic) | [Claude Platform on AWS](https://platform.claude.com/docs/pt-BR/build-with-claude/claude-platform-on-aws) |
| Microsoft Foundry | Microsoft Azure (operado pela Anthropic) | [Claude no Microsoft Foundry](https://platform.claude.com/docs/pt-BR/build-with-claude/claude-in-microsoft-foundry) |
Os Claude Managed Agents estão disponíveis através da Claude API direta e do [Claude Platform on AWS](https://platform.claude.com/docs/pt-BR/build-with-claude/claude-platform-on-aws). Para disponibilidade de recursos entre plataformas, consulte a [Features overview](https://platform.claude.com/docs/pt-BR/build-with-claude/overview).
## Formato de requisição e resposta
### Limites de tamanho de requisição
| Endpoint | Tamanho máximo de requisição |
| ------------------------------------------------------------------------------------------------ | ---------------------------- |
| Messages, Token Counting | 32 MB |
| [Message Batches API](https://platform.claude.com/docs/pt-BR/build-with-claude/batch-processing) | 256 MB |
| [Files API](https://platform.claude.com/docs/pt-BR/build-with-claude/files) | 500 MB |
| Sessions, Agents, Environments | 32 MB |
Se você exceder esses limites, receberá um erro 413 `request_too_large`.
As plataformas operadas por parceiros têm seus próprios limites de tamanho de requisição: o Bedrock limita requisições a 20 MB, e o Google Cloud limita requisições a 30 MB. O Claude Platform on AWS usa os mesmos limites da Claude API direta. Consulte a documentação da sua plataforma para valores atuais.
### Cabeçalhos de resposta
A Claude API inclui os seguintes cabeçalhos em suas respostas:
| Cabeçalho | Descrição |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request-id` | Um identificador globalmente único para a requisição, como `req_018EeWyXxfu5pfWkrYcMdjWG`. Inclua-o ao entrar em contato com o suporte sobre uma requisição específica. Consulte [Request ID](https://platform.claude.com/docs/pt-BR/api/errors#request-id). |
| `anthropic-organization-id` | O ID da organização à qual a chave de API ou o token de acesso usado na requisição pertence. |
| `anthropic-workspace-id` | O ID com prefixo `wrkspc_` do [workspace](https://platform.claude.com/docs/pt-BR/manage-claude/workspaces) ao qual a chave de API ou o token de acesso foi resolvido, como `wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ`, inclusive quando esse é o Default Workspace da sua organização. Ausente quando a credencial não resolve para um workspace (por exemplo, em requisições da Admin API) ou a requisição falha antes de a autenticação ser concluída. Consulte [Identify the workspace behind an API response](https://platform.claude.com/docs/pt-BR/manage-claude/workspaces#identify-the-workspace-behind-an-api-response). |
Para os cabeçalhos de limite de taxa, consulte [Response headers](https://platform.claude.com/docs/pt-BR/api/rate-limits#response-headers) em Rate limits. Para exemplos que leem um cabeçalho de resposta pelo nome com cada SDK, consulte [Identify the workspace behind an API response](https://platform.claude.com/docs/pt-BR/manage-claude/workspaces#identify-the-workspace-behind-an-api-response).
O Claude Platform on AWS adiciona um ID de requisição da AWS (`x-amzn-requestid`) junto com o cabeçalho padrão `request-id`. Consulte [Request IDs](https://platform.claude.com/docs/pt-BR/build-with-claude/claude-platform-on-aws#request-ids) para o padrão de tratamento de ID duplo.
## Paginação
Os 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 consulta `limit` para controlar o tamanho da página e o parâmetro de consulta `page` para buscar uma página adjacente. Cada resposta inclui um array `data` junto com campos de cursor para navegar entre páginas.
| Nome | Localização | Descrição |
| ----------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | Parâmetro de consulta | Número máximo de itens a retornar por página. |
| `page` | Parâmetro de consulta | Cursor opaco de uma resposta anterior. Passe um valor `next_page` ou `prev_page` aqui para buscar a página adjacente. |
| `order` | Parâmetro de consulta | Direção de ordenação para os resultados (`asc` ou `desc`), em endpoints de listagem que suportam ordenação. Um cursor `page` só é válido com o `order` com o qual foi criado. |
| `next_page` | Campo de resposta | Cursor para a próxima página, ou `null` se não houver mais resultados. |
| `prev_page` | Campo de resposta | Cursor para a página anterior em endpoints que suportam paginação para trás (atualmente `GET /v1/sessions`), ou `null` se você estiver na primeira página. Outros endpoints de listagem omitem o campo. |
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 para trás, o campo está ausente da resposta em vez de ser `null`. Para um passo a passo de requisição, consulte [Listing sessions](https://platform.claude.com/docs/pt-BR/managed-agents/session-operations#listing-sessions).
O SDK fornece um iterador com paginação automática que segue `next_page` para você. Por exemplo, `for session in client.beta.sessions.list()` (typescript: `for await (const session of client.beta.sessions.list())`; go: `client.Beta.Sessions.ListAutoPaging()`; java: `client.beta().sessions().list().autoPager()`; csharp: `(await client.Beta.Sessions.List()).Paginate()`; php: `$client->beta->sessions->list()->pagingEachItem()`; ruby: `client.beta.sessions.list.auto_paging_each`) percorre todas as sessões. 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 você mesmo como o parâmetro `page`. Consulte [SDKs de cliente](https://platform.claude.com/docs/pt-BR/cli-sdks-libraries/overview) para mais detalhes.
Alguns endpoints de listagem usam um esquema de cursor diferente. A [Message Batches API](https://platform.claude.com/docs/pt-BR/build-with-claude/batch-processing), a [Models API](https://platform.claude.com/docs/pt-BR/api/models/list) e vários endpoints da [Admin API](https://platform.claude.com/docs/pt-BR/manage-claude/admin-api) recebem os parâmetros de consulta `after_id` e `before_id` em vez de `page`. Suas respostas retornam `has_more`, `first_id` e `last_id` em vez de `next_page`. Consulte a página de referência de cada endpoint para seus campos exatos de paginação.
## Limites de taxa e disponibilidade
### Limites de taxa
A API impõe limites de taxa e limites de gasto 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 mais alto ao longo do tempo. Cada nível tem:
* **Limites de gasto**: 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 ver seus limites de taxa na página [Limites de taxa](https://platform.claude.com/usage/limits) e seus limites de gasto na página [Faturamento](https://platform.claude.com/settings/billing) no Console. Para limites de taxa mais altos ou um teto de gastos mensal maior, use **Request tier increase** na página Limites de taxa.
Para informações detalhadas sobre limites, níveis e o algoritmo de token bucket usado para limitação de taxa, consulte [Rate limits](https://platform.claude.com/docs/pt-BR/api/rate-limits).
### Disponibilidade
A Claude API está disponível em [muitos países e regiões](https://platform.claude.com/docs/pt-BR/api/supported-regions) em todo o mundo. Verifique a página de regiões suportadas para confirmar a disponibilidade em sua localização.
## Próximos passos
Especificação completa da API para interações diretas com o modelo
Endpoints de Agents, Sessions e Environments
Python, TypeScript, C#, Go, Java, PHP e Ruby
Níveis de uso, solicitação de limites mais altos e o algoritmo de token bucket