Claude Messages | Documentação de APIs

# Claude Messages

Native Claude Messages-compatible API. This endpoint uses Anthropic Messages request and response shapes, including tool calls and Anthropic SSE events.

POST https://api.apihop.ai/anthropic/v1/messages

Native Claude Messages-compatible API. This endpoint uses Anthropic Messages request and response shapes, including tool calls and Anthropic SSE events.

Claude Sonnet 4.6 (`claude-sonnet-4-6`) is supported by the upstream supplier but is not currently published on RequestBeam. It is not an active integration default. Before calling any model, confirm access with your own `GET https://api.apihop.ai/v1/models` response.

```text
POST https://api.apihop.ai/anthropic/v1/messages
```

## Authentication

All requests require a RequestBeam API Key. Anthropic SDKs, Claude Code, and compatible clients usually use `x-api-key`; plain HTTP clients may also use Bearer Token authentication.

```http
x-api-key: YOUR_REQUESTBEAM_API_KEY
anthropic-version: 2023-06-01
```

```http
Authorization: Bearer YOUR_REQUESTBEAM_API_KEY
anthropic-version: 2023-06-01
```

## Body

### `model` (string, required, Default: claude-sonnet-5-5)

Supported Claude model IDs.

- `claude-fable-5`
- `claude-fable-5-1`
- `claude-opus-4-6`
- `claude-opus-4-7`
- `claude-opus-4-8`
- `claude-opus-5`
- `claude-opus-5-5`
- `claude-sonnet-5`
- `claude-sonnet-5-5`

Use `GET https://api.apihop.ai/v1/models` for the models currently available to your API Key.

### `max_tokens` (integer, required)

Maximum number of output tokens, as a positive safe integer. This budget includes both thinking and final text output tokens. Missing, zero, negative, fractional, string, or unsafe-integer values return HTTP `400` with `invalid_request_error` before generation or billing. The model may impose a lower maximum.

For models that produce thinking, a small budget such as `128` may yield only thinking blocks before ending with `stop_reason: "max_tokens"`, without text output. Set an explicit budget for the task and the selected model, allowing room for thinking and the final answer. The values in the examples are editable allowances, not upstream defaults or model limits; larger allowances may increase output usage and cost.

### `messages` (object[], required)

Conversation messages. Each message contains `role` and `content`.

`role` supports `user` and `assistant`. `content` may be a string or an array of content blocks.

### `system` (string | object[])

System prompt. Anthropic Messages uses a top-level `system` field instead of a `system` role in `messages`.

### `stream` (boolean, Default: false)

Whether to return Anthropic SSE events.

### `temperature` (number)

Sampling temperature. Accepted values and effects vary by the selected model.

### `top_p` (number)

Nucleus sampling parameter. Acceptance does not guarantee that it changes generation behavior.

### `top_k` (integer)

Top-k sampling parameter. Support depends on the selected model.

### `stop_sequences` (string[])

Stop sequences.

Requests with nonempty stop sequences avoid model services known not to support them; if no compatible service is available, the request returns `400` before generation or billing.

### `tools` (object[])

Anthropic tool definitions. Function tools usually include `name`, `description`, and `input_schema`.

### `tool_choice` (object)

Tool selection policy, such as `{ "type": "auto" }` or `{ "type": "tool", "name": "..." }`.

### `thinking` (object)

Native Anthropic thinking configuration, subject to the selected model and provider's support. Claude 4.5 uses `{ "type": "enabled", "budget_tokens": 1024 }`; Claude Sonnet/Opus 4.6 also support adaptive thinking. Do not apply a manual budget to every model version. In tool continuations, return the complete ordered assistant content, including `thinking`, `signature`, `redacted_thinking` and `tool_use`, unchanged. Keep the thinking configuration and required `anthropic-beta` headers consistent through the tool round trip. For SSE, concatenate `signature_delta.signature` fragments for the same content block; an empty thinking summary does not mean its signature can be discarded. A provider account access rejection is an upstream failure, not evidence of an invalid signature. Recognized Bedrock account access rejections return HTTP 502 with `api_error`; ordinary client validation errors retain HTTP 400. Acceptance still requires an enabled upstream account.

### `metadata` (object)

Request metadata.

### Prompt Caching

Add `cache_control: { "type": "ephemeral" }` to a `system` or message content block. Cache usage may include `cache_creation_input_tokens`, `cache_read_input_tokens`, and supported 5-minute or 1-hour creation buckets. A 1-hour TTL also requires the corresponding `anthropic-beta` header.

## Request Examples

### Non-Streaming

```json
{
  "model": "claude-sonnet-5-5",
  "max_tokens": 1024,
  "messages": [
    {
      "role": "user",
      "content": "Hello, introduce yourself in one sentence."
    }
  ],
  "stream": false
}
```

### Streaming

```json
{
  "model": "claude-sonnet-5-5",
  "max_tokens": 1024,
  "messages": [
    {
      "role": "user",
      "content": "Reply exactly OK."
    }
  ],
  "stream": true
}
```

## Response

Non-streaming responses keep the Anthropic Message shape.

### `id` (string)

Response ID, such as `msg_...`.

### `type` (string)

Object type, usually `message`.

### `role` (string)

Usually `assistant`.

### `model` (string)

Actual Claude model used.

### `content` (object[])

Native output content blocks, including `text`, `tool_use`, and `thinking` when used.

### `stop_reason` (string)

Stop reason, such as `end_turn`, `max_tokens`, `stop_sequence`, or `tool_use`.

### `usage` (object)

Token usage, including `input_tokens` and `output_tokens`. Cache token fields are included when present.

### Success Example

```json
{
  "id": "msg_01...",
  "type": "message",
  "role": "assistant",
  "model": "claude-sonnet-5-5",
  "content": [
    {
      "type": "text",
      "text": "Hello, I am Claude and can help with writing, coding, and analysis tasks."
    }
  ],
  "stop_reason": "end_turn",
  "stop_sequence": null,
  "usage": {
    "input_tokens": 18,
    "output_tokens": 24
  }
}
```

## Streaming Response

When `stream: true`, the endpoint returns Anthropic SSE events. Common events include:

- `message_start`
- `content_block_start`
- `content_block_delta`
- `content_block_stop`
- `ping`
- `message_delta`
- `message_stop`

## Error Response

See [Error Codes and Troubleshooting](https://apihop.ai/en/docs/api-reference/errors) for the full code reference, protocol differences, and diagnostic steps.

Error responses use the Anthropic-style shape:

```json
{
  "type": "error",
  "error": {
    "type": "authentication_error",
    "message": "Invalid credentials or API key has expired."
  }
}
```

API nativa compatível com Claude Messages. Este endpoint usa as estruturas de requisição e resposta Anthropic Messages, incluindo chamadas de ferramentas e eventos SSE Anthropic.

O Claude Sonnet 4.6 (claude-sonnet-4-6) é suportado pelo fornecedor, mas não está publicado atualmente na RequestBeam. Não é o padrão de uma integração ativa. Antes de chamar qualquer modelo, confirme o acesso com sua própria resposta de GET https://api.apihop.ai/v1/models.

text

POST https://api.apihop.ai/anthropic/v1/messages

Autenticação

Todas as requisições exigem uma chave de API RequestBeam. SDKs Anthropic, Claude Code e clientes compatíveis normalmente usam x-api-key; clientes HTTP simples também podem usar autenticação com token Bearer.

http

x-api-key: YOUR_REQUESTBEAM_API_KEY
anthropic-version: 2023-06-01

http

Authorization: Bearer YOUR_REQUESTBEAM_API_KEY
anthropic-version: 2023-06-01

Corpo da requisição

modelstringobrigatórioPadrão: claude-sonnet-5-5

IDs de modelos Claude compatíveis.

claude-fable-5
claude-fable-5-1
claude-opus-4-6
claude-opus-4-7
claude-opus-4-8
claude-opus-5
claude-opus-5-5
claude-sonnet-5
claude-sonnet-5-5

Use GET https://api.apihop.ai/v1/models para consultar os modelos atualmente disponíveis para sua chave de API.

max_tokensintegerobrigatório

Número máximo de tokens de saída, como inteiro positivo seguro. O orçamento inclui tokens de raciocínio e do texto final. Valores ausentes, zero, negativos, fracionários, strings ou inteiros não seguros retornam HTTP 400 com invalid_request_error antes da geração ou cobrança. O modelo pode impor um máximo menor.

Para modelos que produzem raciocínio, um orçamento pequeno como 128 pode gerar apenas blocos de raciocínio antes de terminar com stop_reason: "max_tokens", sem texto. Defina um orçamento explícito para a tarefa e o modelo escolhido, com espaço para raciocínio e resposta final. Os valores dos exemplos são limites editáveis, não padrões do provedor nem limites do modelo; limites maiores podem aumentar o uso de saída e o custo.

messagesobject[]obrigatório

Mensagens da conversa. Cada mensagem contém role e content.

role suporta user e assistant. content pode ser uma string ou um array de blocos de conteúdo.

systemstring | object[]

Prompt do sistema. Anthropic Messages usa um campo system no nível superior em vez de um papel system em messages.

streambooleanPadrão: false

Se deve retornar eventos SSE Anthropic.

temperaturenumber

Temperatura de amostragem. Valores aceitos e efeitos variam conforme o modelo escolhido.

top_pnumber

Parâmetro de amostragem nucleus. A aceitação não garante mudança no comportamento de geração.

top_kinteger

Parâmetro de amostragem top-k. O suporte depende do modelo escolhido.

stop_sequencesstring[]

Sequências de parada.

Requisições com sequências de parada não vazias evitam serviços de modelo que sabidamente não as suportam; se não houver serviço compatível, a requisição retorna 400 antes da geração ou cobrança.

toolsobject[]

Definições de ferramentas Anthropic. Ferramentas de função normalmente incluem name, description e input_schema.

tool_choiceobject

Política de seleção de ferramentas, como { "type": "auto" } ou { "type": "tool", "name": "..." }.

thinkingobject

Configuração nativa de raciocínio Anthropic, sujeita ao suporte do modelo e provedor escolhidos. Claude 4.5 usa { "type": "enabled", "budget_tokens": 1024 }; Claude Sonnet/Opus 4.6 também suportam raciocínio adaptativo. Não aplique orçamento manual a todas as versões do modelo. Nas continuações de ferramentas, devolva sem alterações todo o conteúdo ordenado do assistente, incluindo thinking, signature, redacted_thinking e tool_use. Mantenha a configuração de raciocínio e os cabeçalhos anthropic-beta necessários consistentes durante todo o ciclo da ferramenta. Em SSE, concatene fragmentos signature_delta.signature do mesmo bloco; um resumo vazio de raciocínio não significa que a assinatura possa ser descartada. Uma rejeição de acesso à conta do provedor é uma falha do provedor, não evidência de assinatura inválida. Rejeições reconhecidas de acesso à conta Bedrock retornam HTTP 502 com api_error; erros normais de validação do cliente permanecem HTTP 400. A aceitação ainda exige uma conta do provedor ativada.

metadataobject

Metadados da requisição.

Cache de prompts

Adicione cache_control: { "type": "ephemeral" } a um bloco system ou de conteúdo de mensagem. O uso de cache pode incluir cache_creation_input_tokens, cache_read_input_tokens e categorias de criação compatíveis de 5 minutos ou 1 hora. Um TTL de 1 hora também exige o cabeçalho anthropic-beta correspondente.

Exemplos de requisição

Sem streaming

json

{
  "model": "claude-sonnet-5-5",
  "max_tokens": 1024,
  "messages": [
    {
      "role": "user",
      "content": "Hello, introduce yourself in one sentence."
    }
  ],
  "stream": false
}

Com streaming

json

{
  "model": "claude-sonnet-5-5",
  "max_tokens": 1024,
  "messages": [
    {
      "role": "user",
      "content": "Reply exactly OK."
    }
  ],
  "stream": true
}

Resposta

Respostas sem streaming mantêm a estrutura Anthropic Message.

idstring

ID da resposta, como msg_....

typestring

Tipo de objeto, normalmente message.

rolestring

Normalmente assistant.

modelstring

Modelo Claude realmente usado.

contentobject[]

Blocos nativos de conteúdo de saída, incluindo text, tool_use e thinking quando usado.

stop_reasonstring

Motivo da parada, como end_turn, max_tokens, stop_sequence ou tool_use.

usageobject

Uso de tokens, incluindo input_tokens e output_tokens. Campos de tokens de cache são incluídos quando presentes.

Exemplo de sucesso

json

{
  "id": "msg_01...",
  "type": "message",
  "role": "assistant",
  "model": "claude-sonnet-5-5",
  "content": [
    {
      "type": "text",
      "text": "Hello, I am Claude and can help with writing, coding, and analysis tasks."
    }
  ],
  "stop_reason": "end_turn",
  "stop_sequence": null,
  "usage": {
    "input_tokens": 18,
    "output_tokens": 24
  }
}

Resposta em streaming

Com stream: true, o endpoint retorna eventos SSE Anthropic. Eventos comuns incluem:

message_start
content_block_start
content_block_delta
content_block_stop
ping
message_delta
message_stop

Resposta de erro

Consulte Códigos de erro e solução de problemas para a referência completa, diferenças de protocolo e etapas de diagnóstico.

Respostas de erro usam a estrutura no estilo Anthropic:

json

{
  "type": "error",
  "error": {
    "type": "authentication_error",
    "message": "Invalid credentials or API key has expired."
  }
}