Anthropic API
- 鉴权方式:
Authorization: Bearer <YOUR_API_KEY>。 - 请求头需包含
anthropic-version,示例使用2023-06-01。
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | 用于生成响应的模型 ID。 |
messages | array | 是 | 对话消息列表。每项包含 role(user 或 assistant)和 content;内容可以是字符串或内容块数组。 |
max_tokens | integer | 是 | 生成内容的最大 Token 数,具体上限因模型而异。 |
system | string | array | 否 | 系统指令。Messages API 使用顶层字段,不使用 system 消息角色。 |
stream | boolean | 否 | 设为 true 时以服务器发送事件流式返回响应。 |
stop_sequences | string[] | 否 | 遇到指定字符串时停止生成。 |
tools | array | 否 | 工具定义。每项可包含 name、description 和符合 JSON Schema 的 input_schema 对象。 |
tool_choice | object | 否 | 控制工具选择。常用 type 值为 auto、any、tool 和 none;当 type 为 tool 时使用 name 指定工具。 |
thinking | object | 否 | 思考配置。自适应思考使用 type: “adaptive”;支持手动预算的模型可使用 type: “enabled” 并设置 budget_tokens。 |
output_config | object | 否 | 输出配置。支持该选项的模型可通过 effort 设置推理力度。 |
metadata | object | 否 | 可选请求元数据,例如调用方传入的 user_id。 |
调用示例
cURL
curl "https://api.example.com/v1/messages" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "anthropic-version: 2023-06-01" \
-H "content-type: application/json" \
-d '{
"model": "claude-opus-5-5",
"max_tokens": 1024,
"system": "请清晰、简洁地回答。",
"messages": [
{"role": "user", "content": "用一句话说明 API 的作用。"}
]
}'思考配置
需要使用扩展思考时,在请求中传入 thinking。支持自适应思考的模型使用 type: "adaptive",并可通过 output_config.effort 调整推理力度。
{
"model": "claude-opus-5-5",
"max_tokens": 4096,
"thinking": {
"type": "adaptive"
},
"output_config": {
"effort": "medium"
},
"messages": [
{
"role": "user",
"content": "证明根号 2 是无理数,并写出完整步骤"
}
]
}thinking.type: "adaptive"由模型自行分配思考预算。thinking.type: "enabled"与budget_tokens仅适用于仍支持手动预算的模型;使用前请以模型的公开能力为准。- 普通聊天不需要传入
thinking。
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | 响应消息 ID。 |
model | string | 生成响应的模型。 |
content[] | array | 生成的内容块。文本位于 content[].text;工具调用的类型为 content[].type: “tool_use”。 |
stop_reason | string | null | 生成停止原因,例如 end_turn、max_tokens 或 stop_sequence。 |
usage.input_tokens | integer | 输入 Token 数。 |
usage.output_tokens | integer | 输出 Token 数。 |
{
"id": "msg_example",
"type": "message",
"role": "assistant",
"model": "claude-opus-5-5",
"content": [
{"type": "text", "text": "API 用于定义软件系统之间交换请求和响应的方式。"}
],
"stop_reason": "end_turn",
"stop_sequence": null,
"usage": {"input_tokens": 24, "output_tokens": 14}
}官方参考:Messages API
Last updated on