Skip to main content
POST
Використовуйте POST /v1/messages для надсилання запитів Claude у форматі Anthropic Messages. У прикладах офіційний Anthropic SDK налаштовано з базовою URL-адресою CometAPI та ваш API-ключ зчитується з $COMETAPI_KEY.
Визначення полів і параметри для конкретних моделей дивіться в офіційній довідці API Messages. Для запитів, сумісних з OpenAI, див. Chat Completions.
Автентифікуйтеся за допомогою x-api-key або Authorization: Bearer. Anthropic SDK використовує x-api-key. HTTP-приклади містять anthropic-version: 2023-06-01.

Швидкий старт

Наведені нижче приклади надсилають запит на три пошукові запити. Установіть $COMETAPI_KEY перед їх запуском. Установіть anthropic для Python або @anthropic-ai/sdk для JavaScript:
Відповідь містить масив content. Зчитуйте блоки, у яких type має значення text; блоки thinking та інструментів можуть з’являтися перед текстом.

Керуйте адаптивним мисленням

Установіть thinking.type у значення adaptive і виберіть значення output_config.effort. У наведеному прикладі використовується xhigh і завершене повідомлення зчитується з потоку:
Мислення враховується в обмеженні вихідних даних max_tokens. Залиште місце також для остаточної відповіді, а також для мислення. Відповідь може містити текст без видимого блоку мислення. Зберігайте всі повернені блоки мислення без змін в історії розмови. Інформацію про налаштування мислення для конкретної моделі див. в розділі Мислення. У прикладах не наведено temperature, top_p і top_k; перед додаванням елементів керування вибіркою перегляньте документацію параметрів вибраної моделі.

Кешування Prompt

Установіть точку кешування для довідкових матеріалів, які повторно використовуєте між запитами. Збережіть довідковий матеріал у файлі reference.txt у кодуванні UTF-8 перед запуском цього прикладу. Використовуйте префікс, який відповідає вимозі вибраної моделі щодо мінімальної довжини для кешування:
Повторно виконайте запит з тією самою моделлю, довідковим текстом і налаштуваннями мислення. Перевірте лічильники використання, щоб визначити, чи запит повторно використав префікс:
  • cache_creation_input_tokens підраховує Tokens, записані до кешу.
  • cache_read_input_tokens підраховує Tokens, прочитані з кешу.
  • input_tokens підраховує оброблені вхідні дані поза цими лічильниками кешу.
У повторних запитах cache_read_input_tokens повідомляє, скільки вхідних Tokens було прочитано з кешу. Приклад OpenAPI Кеш Prompt містить повний вигаданий довідковий матеріал, який можна зберегти як reference.txt щоб випробувати приклад.

Потокові відповіді

Установіть stream: true для Server-Sent Events. SDK надає текстові фрагменти в міру їх надходження:
Потік повідомлень містить message_start, події блоків вмісту, message_delta, та message_stop. Блоки вмісту можуть містити текст, міркування або активність інструментів. Для текстового блоку content_block_delta містить text_delta. Зчитайте остаточні дані про використання і причину зупинки з message_delta.

Керування зусиллями

Установіть output_config.effort, щоб визначити обсяг міркувань. У цьому прикладі використовується low для короткого пояснення та очікується завершене потокове повідомлення:
Скористайтеся офіційним довідником щодо зусиль щоб вибрати рівень зусиль. Окремо встановіть max_tokens, щоб обмежити довжину виводу.

Використовуйте серверні інструменти

Серверні інструменти виконуються під час API-запиту та повертають блоки результатів разом із відповіддю Claude.
Завантажте статтю та попросіть Claude використати отриманий документ у своїй відповіді. У цьому прикладі відповідь передається потоково й перевіряються як остаточний текст, так і web_fetch_tool_result блок:
Відповідь поєднує блок server_tool_use з web_fetch_tool_result, що містить завантажений документ або помилку інструмента.

Повернення результатів клієнтських інструментів

Для клієнтського інструмента Claude повертає блок tool_use. Запустіть функцію вашого застосунку і надішліть її результат у блоці tool_result з відповідним tool_use_id. Збережіть повний вміст відповіді асистента між двома запитами. У цьому прикладі надається вигаданий результат замовлення та пропонується Claude використати цей результат:

Приклад відповіді

Запит без Streaming повертає об’єкт повідомлення. У наведеному нижче прикладі показано його текстове поле та поля використання з ілюстративним ідентифікатором повідомлення:
Причина зупинки описує наступну дію. end_turn завершує відповідь, max_tokens означає, що вивід досяг ліміту, а tool_use запитує результат клієнтського інструмента. Якщо хід із серверним інструментом повертає pause_turn, продовжуйте з незміненим вмістом відповіді асистента.

Авторизації

x-api-key
string
header
обов'язково

Your CometAPI key passed via the x-api-key header. Authorization: Bearer $COMETAPI_KEY is also supported.

Заголовки

anthropic-version
string
за замовчуванням:2023-06-01

The Anthropic API version to use. Defaults to 2023-06-01.

Приклад:

"2023-06-01"

anthropic-beta
string

Comma-separated feature identifiers required by a specific beta API feature. Omit this header for the examples on this page.

Тіло

application/json
model
string
за замовчуванням:claude-opus-5
обов'язково

The Claude model to use. See the Models page for available Claude model IDs.

Приклад:

"claude-opus-5"

messages
object[]
обов'язково

Conversation history. Use user and assistant messages with text strings or content-block arrays. Return complete assistant content blocks when continuing a tool call.

max_tokens
integer
обов'язково

The maximum number of tokens to generate. The model may stop before reaching this limit. When using thinking, the thinking tokens count towards this limit.

Необхідний діапазон: x >= 1
Приклад:

1024

system

System prompt providing context and instructions to Claude. Can be a plain string or an array of content blocks (useful for prompt caching).

temperature
number

Sampling temperature. The examples omit sampling overrides.

Необхідний діапазон: 0 <= x <= 1
top_p
number

Nucleus sampling threshold. The examples omit sampling overrides.

Необхідний діапазон: 0 <= x <= 1
top_k
integer

Limits sampling to the k most likely tokens. The examples omit sampling overrides.

Необхідний діапазон: x >= 0
stream
boolean
за замовчуванням:false

If true, stream the response incrementally using Server-Sent Events (SSE). Events include message_start, content_block_start, content_block_delta, content_block_stop, message_delta, and message_stop.

stop_sequences
string[]

Custom strings that cause the model to stop generating when encountered. The stop sequence is not included in the response.

thinking
object

Thinking configuration. The adaptive example uses type adaptive and sets output_config.effort separately.

tools
object[]

Client tools define a name and input_schema. Server tools use a versioned type and name, such as the web_fetch and web_search examples on this page.

tool_choice
object

Controls how the model uses tools.

metadata
object

Request metadata for tracking and analytics.

output_config
object

Configuration for reasoning effort and structured output.

service_tier
enum<string>

The service tier to use. auto tries priority capacity first, standard_only uses only standard capacity.

Доступні опції:
auto,
standard_only

Відповідь

Successful response. When stream is true, the response is a stream of SSE events.

id
string

Message identifier returned by the API.

type
enum<string>

Always message.

Доступні опції:
message
role
enum<string>

Always assistant.

Доступні опції:
assistant
content
object[]

The response content blocks. May include text, thinking, tool_use, and other block types.

model
string

Model ID reported by the response.

stop_reason
enum<string>

Why the model stopped generating. refusal can be returned as a successful HTTP response when the model declines a request.

Доступні опції:
end_turn,
max_tokens,
stop_sequence,
tool_use,
pause_turn,
refusal
stop_sequence
string | null

The stop sequence that caused the model to stop, if applicable.

usage
object

Token usage statistics.

Останнє оновлення 8 вересня 2026 р.