Crear un mensaje
Llame a Claude mediante el endpoint Anthropic Messages de CometAPI con entrada de texto e imágenes, pensamiento adaptativo, almacenamiento en caché de Prompt, Streaming y herramientas.
POST /v1/messages para enviar solicitudes a Claude en el formato Anthropic Messages.
Los ejemplos configuran el SDK oficial de Anthropic con la URL base de CometAPI y
leen su clave de API de $COMETAPI_KEY.
x-api-key o Authorization: Bearer. El SDK de Anthropic usa
x-api-key. Los ejemplos HTTP incluyen anthropic-version: 2023-06-01.Inicio rápido
Los siguientes ejemplos solicitan tres consultas de búsqueda. Configure$COMETAPI_KEY antes de
ejecutarlos. Instale anthropic para Python o @anthropic-ai/sdk para JavaScript:
content. Lea los bloques cuyo type sea text;
pueden aparecer bloques de pensamiento y herramientas antes del texto.
Controla el pensamiento adaptativo
Establecethinking.type en adaptive y elige un valor para output_config.effort.
El siguiente ejemplo usa xhigh y lee el mensaje completado de una transmisión:
max_tokens. Deja espacio para la respuesta final,
además del pensamiento. Una respuesta puede contener texto sin un bloque de pensamiento visible.
Conserva sin cambios los bloques de pensamiento devueltos en el historial de la conversación
.
Para conocer la configuración de pensamiento específica del modelo, consulta
Pensamiento.
Los ejemplos omiten temperature, top_p y top_k; consulta la documentación de parámetros del modelo seleccionado
antes de agregar controles de muestreo.
Almacena Prompts en caché
Coloca un punto de interrupción de caché en el material de referencia que reutilizas entre solicitudes. Guarda el material de referencia en un archivoreference.txt con codificación UTF-8 antes de ejecutar este
ejemplo. Usa un prefijo que cumpla con la
longitud mínima apta para caché:
cache_creation_input_tokenscuenta los tokens escritos en la caché.cache_read_input_tokenscuenta los tokens leídos de la caché.input_tokenscuenta la entrada procesada fuera de esos contadores de caché.
cache_read_input_tokens informa cuántos tokens de entrada
se leyeron de la caché. El ejemplo OpenAPI Prompt Cache
contiene una referencia ficticia completa que puedes guardar como
reference.txt para probar el ejemplo.
Transmitir respuestas
Establecestream: true para Server-Sent Events. El SDK expone fragmentos de texto a medida que
llegan:
message_start, eventos de bloques de contenido, message_delta,
y message_stop. Los bloques de contenido pueden contener texto, razonamiento o actividad de herramientas.
Para un bloque de texto, content_block_delta contiene un text_delta. Lee el uso final
y el motivo de detención de message_delta.
Control del esfuerzo
Estableceoutput_config.effort para orientar la cantidad de razonamiento. Este ejemplo usa
low para una explicación breve y espera a que se complete el mensaje transmitido:
max_tokens por separado para limitar la longitud de salida.
Usar herramientas de servidor
Las herramientas del servidor se ejecutan durante la solicitud a la API y devuelven bloques de resultados junto con la respuesta de Claude.- Web Fetch
- Web Search
web_fetch_tool_result bloque:server_tool_use con un web_fetch_tool_result
que contiene el documento recuperado o un error de herramienta.Devolver resultados de herramientas de cliente
Para una herramienta de cliente, Claude devuelve un bloquetool_use. Ejecuta la función de tu aplicación
y envía su resultado en un bloque tool_result con el tool_use_id correspondiente.
Conserva el contenido completo del asistente entre las dos solicitudes.
Este ejemplo proporciona un resultado de pedido ficticio y le pide a Claude que use ese resultado:
Ejemplo de respuesta
Una solicitud sin Streaming devuelve un objeto de mensaje. El siguiente ejemplo muestra sus campos de texto y uso con un identificador de mensaje ilustrativo:end_turn completa la respuesta,
max_tokens significa que la salida alcanzó el límite y tool_use solicita el resultado de una herramienta de cliente.
Para un turno de herramienta de servidor que devuelve pause_turn, continúa con el
contenido devuelto del asistente sin cambios.Autorizaciones
Your CometAPI key passed via the x-api-key header. Authorization: Bearer $COMETAPI_KEY is also supported.
Encabezados
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.
Cuerpo
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 Respuesta
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.