Série de Texto
API Claude Messages
- Totalmente compatível com o formato da API Claude Messages
- Suporta conversas em múltiplas rodadas e consultas únicas
- Suporta conteúdo multimodal incluindo texto e imagens
POST
Documentation Index
Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt
Use this file to discover all available pages before exploring further.
Autorizações
Chave de API para autenticaçãoAcesse a página de gerenciamento de chaves de API para obter sua chave de APIAdicione-a ao cabeçalho da requisição:
Versão da APIEspecifica a versão da API Claude a ser utilizadaExemplo:
2025-10-01Body
Nome do modelo
claude-haiku-4-5-20251001- Claude 4.5, versão de resposta rápidaclaude-sonnet-4-5-20250929- Claude 4.5, versão equilibradaclaude-opus-4-1-20250805- Claude 4.1, modelo principal mais poderosoclaude-opus-4-1-20250805-thinking- Claude 4.1 Opus, versão com raciocínio profundoclaude-sonnet-4-5-20250929-thinking- Claude 4.5 Sonnet, versão com raciocínio profundo
Lista de mensagensArray de mensagens para o modelo gerar a próxima resposta. Cada mensagem contém os campos Conversa em múltiplas rodadas:Resposta do assistente pré-preenchida:
role e content.💡 Preenchimento rápido (área Try it):- Clique em ”+ Add an item” para adicionar uma mensagem
- Em
role, informe:user(mensagem do usuário) ouassistant(resposta da IA, para múltiplas rodadas) - Em
content, informe o texto da sua mensagem
Máximo de tokens a serem geradosNúmero máximo de tokens a serem gerados antes de parar. O modelo pode parar antes de atingir esse limite.Modelos diferentes possuem valores máximos distintos. Mínimo: 1
Prompt do sistemaOs prompts do sistema definem o papel, a personalidade, os objetivos e as instruções do Claude.Formato string:Formato estruturado:
Parâmetro de temperatura, faixa 0–1Controla a aleatoriedade da saída:
- Valores baixos (por exemplo, 0.2): mais determinístico, conservador
- Valores altos (por exemplo, 0.8): mais aleatório, criativo
Parâmetro de amostragem por núcleo (nucleus sampling), faixa 0–1Utiliza amostragem por núcleo. Recomenda-se usar
temperature OU top_p, não ambos.Padrão: 1.0Amostragem Top-KAmostra apenas a partir das K principais opções, removendo respostas de baixa probabilidade da “cauda longa”.Recomendado apenas para casos de uso avançados.
Habilitar streamingQuando
true, usa Server-Sent Events (SSE) para transmitir as respostas em streaming.Padrão: falseSequências de paradaSequências de texto personalizadas que fazem o modelo parar de gerar.Máximo de 4 sequências.Exemplo:
["\n\nHuman:", "\n\nAssistant:"]MetadadosObjeto de metadados para a requisição.Inclui:
user_id: identificador do usuário
Definições de ferramentasLista de ferramentas que o modelo pode usar para concluir as tarefas.Exemplo de ferramenta de função:Tipos de ferramentas suportadas:
- Ferramentas de função personalizadas
- Ferramenta de uso do computador (computer_20241022)
- Ferramenta de edição de texto (text_editor_20241022)
- Ferramenta Bash (bash_20241022)
Estratégia de escolha de ferramentaControla como o modelo usa as ferramentas:
{"type": "auto"}: decisão automática (padrão){"type": "any"}: deve usar uma ferramenta{"type": "tool", "name": "tool_name"}: usar uma ferramenta específica
Resposta
Identificador único da mensagemExemplo:
"msg_013Zva2CMHLNnXjNJJKqJ2EF"Tipo do objetoSempre
"message"PapelSempre
"assistant"Array de blocos de conteúdoConteúdo gerado pelo modelo, como um array de blocos de conteúdo.Conteúdo de texto:Uso de ferramenta:Tipos de conteúdo:
text: conteúdo de textotool_use: invocação de ferramenta
Modelo que processou a requisiçãoExemplo:
"claude-sonnet-4-5-20250929"Motivo da paradaValores possíveis:
end_turn: conclusão naturalmax_tokens: atingiu o limite máximo de tokensstop_sequence: encontrou uma sequência de paradatool_use: invocou uma ferramenta
Sequência de parada acionadaA sequência de parada gerada, se houver; caso contrário,
nullEstatísticas de uso de tokens
Exemplos de uso
Conversa simples
Conversa em múltiplas rodadas
Uso de prompts do sistema
Resposta em streaming
Uso de ferramentas
Compreensão visual
Imagem em Base64
Boas práticas
1. Engenharia de prompts
Definição clara do papel:2. Tratamento de erros
3. Otimização de tokens
4. Pré-preenchimento de respostas
Tratamento de respostas em streaming
Streaming em Python
Streaming em JavaScript
Observações importantes
-
Segurança da chave de API:
- Armazene as chaves de API em variáveis de ambiente
- Nunca insira chaves diretamente no código-fonte
- Faça a rotação das chaves regularmente
-
Limite de taxa:
- Esteja atento aos limites de taxa da API
- Implemente mecanismos de retry
- Use exponential backoff
-
Gerenciamento de tokens:
- Monitore o consumo de tokens
- Otimize o tamanho dos prompts
- Use valores adequados para max_tokens
-
Seleção de modelo:
- Opus: tarefas complexas, que exigem raciocínio profundo
- Sonnet: desempenho e custo equilibrados
- Haiku: resposta rápida, tarefas simples
-
Filtragem de conteúdo:
- Valide a entrada do usuário
- Filtre informações sensíveis
- Implemente moderação de conteúdo