Створити повідомлення
Викликайте Claude через кінцеву точку Messages CometAPI з текстовим і графічним введенням, адаптивним мисленням, кешуванням Prompt, Streaming та інструментами.
POST /v1/messages для надсилання запитів Claude у форматі Anthropic Messages.
У прикладах офіційний Anthropic SDK налаштовано з базовою URL-адресою CometAPI та
ваш API-ключ зчитується з $COMETAPI_KEY.
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.- Вебзавантаження
- Вебпошук
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, продовжуйте з
незміненим вмістом відповіді асистента.Авторизації
Your CometAPI key passed via the x-api-key header. Authorization: Bearer $COMETAPI_KEY is also supported.
Заголовки
The Anthropic API version to use. Defaults to 2023-06-01.
"2023-06-01"
Comma-separated feature identifiers required by a specific beta API feature. Omit this header for the examples on this page.
Тіло
The Claude model to use. See the Models page for available Claude model IDs.
"claude-opus-5"
Conversation history. Use user and assistant messages with text strings or content-block arrays. Return complete assistant content blocks when continuing a tool call.
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 >= 11024
System prompt providing context and instructions to Claude. Can be a plain string or an array of content blocks (useful for prompt caching).
Sampling temperature. The examples omit sampling overrides.
0 <= x <= 1Nucleus sampling threshold. The examples omit sampling overrides.
0 <= x <= 1Limits sampling to the k most likely tokens. The examples omit sampling overrides.
x >= 0If 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.
Custom strings that cause the model to stop generating when encountered. The stop sequence is not included in the response.
Thinking configuration. The adaptive example uses type adaptive and sets output_config.effort separately.
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.
Controls how the model uses tools.
Request metadata for tracking and analytics.
Configuration for reasoning effort and structured output.
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.
Message identifier returned by the API.
Always message.
message Always assistant.
assistant The response content blocks. May include text, thinking, tool_use, and other block types.
Model ID reported by the response.
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 The stop sequence that caused the model to stop, if applicable.
Token usage statistics.