Claude Messages

x-api-key string Обязательно

Используйте ключ BeatAPI. Также поддерживается Authorization: Bearer <BEATAPI_API_KEY>.

model string Обязательно

Точный ID модели.

Допустимые значения: claude-fable-5-1, claude-opus-5-5, claude-sonnet-5-5, claude-haiku-5-5

• Прежние рабочие ID (claude-opus-5, claude-sonnet-5, claude-haiku-4-5-20251001) перечислены в разделе Старые модели.
• Вызовите GET /v1/models со своим ключом, чтобы проверить, какие модели ему доступны.

max_tokens integer Обязательно

Максимальное число генерируемых токенов, включая рассуждения.

• Всегда передавайте это поле. Если его нет или оно равно 0, применяется лимит по умолчанию, который может оказаться ниже ожидаемого.
• Максимально допустимое значение — 1 073 741 823; превышение возвращает 400 bad_request. При этом не превышайте максимальный объём вывода модели из таблицы выше.
• max_tokens также используется для оценки необходимого баланса. Слишком большое значение может привести к 402 insufficient_credits, даже если фактический ответ был бы коротким. Указывайте столько токенов, сколько требуется задаче.

messages object[] Обязательно

История диалога, от самого раннего сообщения к последнему. У каждого сообщения есть role (user или assistant) и content. В content передаётся строка либо массив блоков содержимого.

• Основные типы блоков: text, image (источник base64 или URL), tool_use (в сообщении assistant) и tool_result (в сообщении user).
• Пустой или отсутствующий массив messages приводит к 400 bad_request.

Пример

[
  {
    "role": "user",
    "content": [
      { "type": "text", "text": "What is in this image?" },
      { "type": "image", "source": { "type": "base64", "media_type": "image/png", "data": "<base64>" } }
    ]
  }
]

system string | object[] Необязательно

Системный промпт: строка либо массив блоков text. Добавьте cache_control к блоку, чтобы кэшировать длинный неизменяемый префикс.

Пример

[
  {
    "type": "text",
    "text": "<long, stable instructions>",
    "cache_control": { "type": "ephemeral" }
  }
]

stream boolean НеобязательноПо умолчанию: false

Передавать ответ потоком событий SSE. См. раздел о потоковой передаче ниже.

По умолчанию: false

stop_sequences string[] Необязательно

Строки, при обнаружении которых генерация прекращается. В ответе будет stop_reason: "stop_sequence".

tools object[] Необязательно

Инструменты, которые может вызвать модель. У каждого есть name, description и input_schema (JSON Schema). При вызове инструмента модель возвращает stop_reason: "tool_use"; выполните инструмент и передайте результат в следующем блоке tool_result.

Пример

[
  {
    "name": "get_weather",
    "description": "Get the current weather for a city.",
    "input_schema": {
      "type": "object",
      "properties": { "city": { "type": "string" } },
      "required": ["city"]
    }
  }
]

tool_choice object Необязательно

Нужно ли модели использовать tools и каким образом.

Допустимые значения: {"type":"auto"}, {"type":"any"}, {"type":"tool","name":"..."}, {"type":"none"}

• auto оставляет выбор модели, any требует вызвать любой инструмент, tool — инструмент по имени, none запрещает инструменты.

Пример

{ "type": "auto" }
{ "type": "tool", "name": "get_weather" }

thinking object Необязательно

Расширенные рассуждения. Поле type включает или отключает их. Токены рассуждений входят в лимит max_tokens и оплачиваются как выходные.

Допустимые значения: adaptive, enabled, disabled

• thinking.type принимает одно из значений выше. При enabled задайте thinking.budget_tokens: целое число не меньше 1 024 и меньше max_tokens.
• thinking.display принимает summarized или omitted. Новые модели могут не возвращать текст рассуждений, если не запросить summarized.
• Глубина адаптивных рассуждений задаётся через output_config.effort.

Зависит от модели

• claude-fable-5-1: Используйте {"type":"adaptive"} и задавайте глубину через output_config.effort; budget_tokens отклоняется.
• claude-opus-5-5: Используйте {"type":"adaptive"} и задавайте глубину через output_config.effort; budget_tokens отклоняется.
• claude-sonnet-5-5: Используйте {"type":"adaptive"} и задавайте глубину через output_config.effort; budget_tokens отклоняется.

Пример

{
  "thinking": { "type": "adaptive" },
  "output_config": { "effort": "high" }
}

output_config.effort string Необязательно

Интенсивность рассуждений модели. Начните с high, затем на своих задачах сравните уровень выше и ниже.

Допустимые значения: low, medium, high, xhigh, max

cache_control object Необязательно

Кэширование промпта. Добавьте к блоку system, messages или tools, чтобы кэшировать всё до этого блока включительно, либо на верхний уровень запроса. Значение ttl: 5m (по умолчанию) или 1h.

Допустимые значения: {"type":"ephemeral"}

• Чтение кэша, запись на 5 минут и запись на 1 час оплачиваются отдельно. Кэшированный префикс оплачивается как чтение кэша, а не как новый вход.
• Количество токенов при чтении и создании кэша указано в usage.cache_read_input_tokens и usage.cache_creation_input_tokens.

Пример

{ "type": "ephemeral" }
{ "type": "ephemeral", "ttl": "1h" }