Skip to main content
POST
Bruk POST /v1/messages til å sende Claude-forespørsler i Anthropic Messages-formatet. Eksemplene konfigurerer den offisielle Anthropic SDK-en med CometAPI-base-URL-en og leser API-nøkkelen din fra $COMETAPI_KEY.
For feltdefinisjoner og modellspesifikke alternativer kan du se den offisielle Messages API-referansen. For OpenAI-kompatible forespørsler, se Chat Completions.
Autentiser med x-api-key eller Authorization: Bearer. Anthropic SDK-en bruker x-api-key. HTTP-eksemplene inkluderer anthropic-version: 2023-06-01.

Hurtigstart

Eksemplene nedenfor ber om tre søkespørringer. Angi $COMETAPI_KEY før du kjører dem. Installer anthropic for Python eller @anthropic-ai/sdk for JavaScript:
Svaret inneholder en content-array. Les blokker der type er text; blokker for tenkning og verktøy kan vises før teksten.

Kontroller adaptiv tenkning

Sett thinking.type til adaptive, og velg en output_config.effort-verdi. Følgende eksempel bruker xhigh og leser den fullførte meldingen fra en strøm:
Tenkning bidrar til utdata-grensen for max_tokens. La det være plass til det endelige svaret samt tenkning. Et svar kan inneholde tekst uten en synlig tenkningsblokk. Behold eventuelle returnerte tenkningsblokker uendret i samtale historikken. Se Thinking. Eksemplene utelater temperature, top_p og top_k; se dokumentasjonen for den valgte modellens parametere før du legger til samplingkontroller.

Mellomlagre Prompt-er

Plasser et cache-breakpoint på referansemateriale som du gjenbruker mellom forespørsler. Lagre referansematerialet ditt i en UTF-8-reference.txt-fil før du kjører dette eksempelet. Bruk et prefiks som oppfyller den valgte modellens minste mellomlagringsbare lengde:
Kjør forespørselen på nytt med samme modell, referansetekst og tenkningsinnstillinger. Undersøk brukstellerne for å avgjøre om forespørselen gjenbrukte et prefiks:
  • cache_creation_input_tokens teller tokens som skrives til cachen.
  • cache_read_input_tokens teller tokens som leses fra cachen.
  • input_tokens teller inndata som behandles utenfor disse cache-tellerne.
Ved gjentatte forespørsler rapporterer cache_read_input_tokens hvor mange input tokens som ble lest fra cachen. OpenAPI- Prompt Cache -eksempelet inneholder en komplett fiktiv referanse som du kan lagre som reference.txt for å prøve eksempelet.

Strøm svar

Angi stream: true for Server-Sent Events. SDK-en eksponerer tekstfragmenter etter hvert som de ankommer:
En meldingsstrøm inneholder message_start, innholdsblokkhendelser, message_delta, og message_stop. Innholdsblokker kan inneholde tekst, tenkning eller verktøyaktivitet. For en tekstblokk inneholder content_block_delta en text_delta. Les endelige bruksdata og stoppårsaken fra message_delta.

Kontroller innsats

Angi output_config.effort for å styre mengden resonnering. Dette eksemplet bruker low for en kort forklaring og venter på den fullførte strømmede meldingen:
Bruk den offisielle referansen for innsats for å velge et innsatsnivå. Angi max_tokens separat for å begrense utdataenes lengde.

Bruk serververktøy

Serververktøy kjøres under API-forespørselen og returnerer resultatblokker sammen med Claudes svar.
Hent en artikkel og be Claude bruke det hentede dokumentet i svaret sitt. Dette eksemplet streamer svaret og undersøker både den endelige teksten og web_fetch_tool_result blokken:
Svaret kombinerer en server_tool_use-blokk med en web_fetch_tool_result som inneholder det hentede dokumentet eller en verktøyfeil.

Returner resultater fra klientverktøy

For et klientverktøy returnerer Claude en tool_use-blokk. Kjør applikasjonsfunksjonen og send resultatet i en tool_result-blokk med den samsvarende tool_use_id. Behold alt assistentinnholdet mellom de to forespørslene. Dette eksemplet oppgir et fiktivt bestillingsresultat og ber Claude bruke dette resultatet:

Svareksempel

En forespørsel uten strømming returnerer et meldingsobjekt. Følgende eksempel viser dets tekst- og bruksfelt med en illustrativ meldingsidentifikator:
Stoppårsaken beskriver neste handling. end_turn fullfører svaret, max_tokens betyr at utdataene nådde grensen, og tool_use ber om et klientverktøy resultat. For en serververktøyrunde som returnerer pause_turn, fortsett med det returnerte assistentinnholdet uendret.

Autorisasjoner

x-api-key
string
header
påkrevd

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

Overskrifter

anthropic-version
string
standard:2023-06-01

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

Eksempel:

"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.

Kropp

application/json
model
string
standard:claude-opus-5
påkrevd

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

Eksempel:

"claude-opus-5"

messages
object[]
påkrevd

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
påkrevd

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.

Nødvendig område: x >= 1
Eksempel:

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.

Nødvendig område: 0 <= x <= 1
top_p
number

Nucleus sampling threshold. The examples omit sampling overrides.

Nødvendig område: 0 <= x <= 1
top_k
integer

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

Nødvendig område: x >= 0
stream
boolean
standard: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.

Tilgjengelige alternativer:
auto,
standard_only

Svar

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.

Tilgjengelige alternativer:
message
role
enum<string>

Always assistant.

Tilgjengelige alternativer:
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.

Tilgjengelige alternativer:
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.

Sist endret 8. september 2026