Claude Messages | API Belgeleri

# 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."
  }
}
```

Yerel Claude Messages uyumlu API. Bu uç nokta, araç çağrıları ve Anthropic SSE olayları dahil Anthropic Messages istek ve yanıt yapılarını kullanır.

Claude Sonnet 4.6 (claude-sonnet-4-6) üst sağlayıcı tarafından desteklenir ancak şu anda RequestBeam’de yayımlanmamıştır. Etkin bir entegrasyon varsayılanı değildir. Herhangi bir modeli çağırmadan önce kendi GET https://api.apihop.ai/v1/models yanıtınızla erişimi doğrulayın.

text

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

Kimlik doğrulama

Tüm istekler RequestBeam API anahtarı gerektirir. Anthropic SDK’ları, Claude Code ve uyumlu istemciler genellikle x-api-key kullanır; düz HTTP istemcileri Bearer belirteciyle de kimlik doğrulayabilir.

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

İstek gövdesi

modelstringzorunluVarsayılan: claude-sonnet-5-5

Desteklenen Claude model kimlikleri.

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

API anahtarınızın şu anda erişebildiği modeller için GET https://api.apihop.ai/v1/models kullanın.

max_tokensintegerzorunlu

Pozitif güvenli tam sayı olarak azami çıktı token sayısı. Bu bütçe hem düşünme hem nihai metin çıktı tokenlarını kapsar. Eksik, sıfır, negatif, kesirli, dize veya güvenli olmayan tam sayı değerleri üretim ya da faturalandırma öncesinde HTTP 400 ve invalid_request_error döndürür. Model daha düşük bir üst sınır uygulayabilir.

Düşünme üreten modellerde 128 gibi küçük bütçe, metin çıktısı olmadan stop_reason: "max_tokens" ile bitmeden önce yalnızca düşünme blokları üretebilir. Göreve ve seçilen modele açık bir bütçe ayırın; düşünme ve nihai yanıt için yer bırakın. Örneklerdeki değerler düzenlenebilir izinlerdir; üst sağlayıcı varsayılanları veya model sınırları değildir. Daha büyük izinler çıktı kullanımını ve maliyeti artırabilir.

messagesobject[]zorunlu

Konuşma mesajları. Her mesaj role ve content içerir.

role, user ve assistant destekler. content bir dize veya içerik blokları dizisi olabilir.

systemstring | object[]

Sistem istemi. Anthropic Messages, messages içindeki system rolü yerine üst düzey system alanı kullanır.

streambooleanVarsayılan: false

Anthropic SSE olaylarının döndürülüp döndürülmeyeceği.

temperaturenumber

Örnekleme sıcaklığı. Kabul edilen değerler ve etkiler seçilen modele göre değişir.

top_pnumber

Çekirdek örnekleme parametresi. Kabul edilmesi, üretim davranışını değiştireceğini garanti etmez.

top_kinteger

Top-k örnekleme parametresi. Destek seçilen modele bağlıdır.

stop_sequencesstring[]

Durdurma dizileri.

Boş olmayan durdurma dizilerine sahip istekler, bunları desteklemediği bilinen model hizmetlerini kullanmaz; uyumlu hizmet yoksa istek üretim veya faturalandırma öncesinde 400 döndürür.

toolsobject[]

Anthropic araç tanımları. İşlev araçları genellikle name, description ve input_schema içerir.

tool_choiceobject

{ "type": "auto" } veya { "type": "tool", "name": "..." } gibi araç seçimi ilkesi.

thinkingobject

Seçilen modelin ve sağlayıcının desteğine bağlı yerel Anthropic düşünme yapılandırması. Claude 4.5, { "type": "enabled", "budget_tokens": 1024 } kullanır; Claude Sonnet/Opus 4.6 uyarlanabilir düşünmeyi de destekler. Her model sürümüne manuel bütçe uygulamayın. Araç devamlarında thinking, signature, redacted_thinking ve tool_use dahil sıralı asistan içeriğinin tamamını değiştirmeden geri gönderin. Araç gidiş dönüşü boyunca düşünme yapılandırmasını ve gerekli anthropic-beta başlıklarını tutarlı tutun. SSE için aynı içerik bloğunun signature_delta.signature parçalarını birleştirin; boş düşünme özeti, imzanın atılabileceği anlamına gelmez. Sağlayıcı hesabı erişiminin reddedilmesi üst sağlayıcı hatasıdır, geçersiz imza kanıtı değildir. Tanınan Bedrock hesap erişim retleri api_error ile HTTP 502 döndürür; olağan istemci doğrulama hataları HTTP 400 olarak kalır. Kabul hâlâ etkin bir üst sağlayıcı hesabı gerektirir.

metadataobject

İstek meta verileri.

İstem önbellekleme

system veya mesaj içerik bloğuna cache_control: { "type": "ephemeral" } ekleyin. Önbellek kullanımı cache_creation_input_tokens, cache_read_input_tokens ve desteklenen 5 dakikalık veya 1 saatlik oluşturma gruplarını içerebilir. 1 saatlik TTL ayrıca ilgili anthropic-beta başlığını gerektirir.

İstek örnekleri

Akışsız

json

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

Akışlı

json

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

Yanıt

Akışsız yanıtlar Anthropic Message yapısını korur.

idstring

msg_... gibi yanıt kimliği.

typestring

Genellikle message olan nesne türü.

rolestring

Genellikle assistant.

modelstring

Gerçekte kullanılan Claude modeli.

contentobject[]

text, tool_use ve kullanıldığında thinking dahil yerel çıktı içerik blokları.

stop_reasonstring

end_turn, max_tokens, stop_sequence veya tool_use gibi durma nedeni.

usageobject

input_tokens ve output_tokens dahil token kullanımı. Varsa önbellek token alanları da dahil edilir.

Başarılı yanıt örneği

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
  }
}

Akışlı yanıt

stream: true olduğunda uç nokta Anthropic SSE olayları döndürür. Yaygın olaylar şunlardır:

message_start
content_block_start
content_block_delta
content_block_stop
ping
message_delta
message_stop

Hata yanıtı

Tam kod başvurusu, protokol farkları ve tanılama adımları için Hata kodları ve sorun giderme sayfasına bakın.

Hata yanıtları Anthropic tarzı yapıyı kullanır:

json

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