跳转到主要内容
POST

Authorizations

x-api-key
string
必填
API密钥用于身份验证访问 API Key 管理页面 获取您的 API Key在请求头中添加:
anthropic-version
string
必填
API版本号指定要使用的Claude API版本示例:2025-10-01

Body

model
string
默认值:"claude-sonnet-4-6"
必填
模型名称
  • claude-opus-4-8 - Claude Opus 4.8 旗舰模型
  • claude-opus-4-7 - Claude Opus 4.7 旗舰模型
  • claude-opus-4-6 - Claude Opus 4.6 旗舰模型
  • claude-sonnet-4-6 - Claude Sonnet 4.6 平衡版本
  • claude-opus-4-5-20251101 - Claude Opus 4.5 模型
messages
array
必填
消息列表消息数组,模型会基于这些消息生成下一条回复。每条消息包含 rolecontent 两个字段。💡 快速填写(Try it 区域):
  1. 点击 ”+ Add an item” 添加一条消息
  2. role 输入:user(用户消息)或 assistant(AI回复,用于多轮对话)
  3. content 输入:你想说的话
单条用户消息示例:
多轮对话示例:
预填充助手回复:
max_tokens
integer
最大生成token数生成停止前的最大token数量。模型可能会在达到此限制前停止。不同模型有不同的最大值,请参考模型文档。最小值:1
system
string | array
系统提示词系统提示词用于设置Claude的角色、个性、目标和指令。字符串格式:
结构化格式:
temperature
number
温度参数,范围 0-1控制输出的随机性:
  • 低值(如0.2):更确定、更保守
  • 高值(如0.8):更随机、更有创意
默认值:1.0
top_p
number
核采样参数,范围 0-1使用nucleus sampling。建议使用 temperaturetop_p 其中之一,不要同时使用。默认值:1.0
top_k
integer
Top-K采样只从概率最高的K个选项中采样,用于移除”长尾”低概率响应。建议仅在高级用例中使用。
stream
boolean
是否启用流式输出设置为 true 时,使用服务器发送事件(SSE)流式返回响应。默认值:false
stop_sequences
array
停止序列自定义文本序列,遇到这些序列时模型将停止生成。最多4个序列。示例:["\n\nHuman:", "\n\nAssistant:"]
metadata
object
元数据用于请求的元数据对象。包含:
  • user_id: 用户标识符
tools
array
工具定义工具列表,模型可以调用这些工具来完成任务。函数工具示例:
支持的工具类型:
  • 自定义函数工具
  • 计算机使用工具(computer_20241022)
  • 文本编辑器工具(text_editor_20241022)
  • Bash工具(bash_20241022)
tool_choice
object
工具选择策略控制模型如何使用工具:
  • {"type": "auto"}: 自动决定(默认)
  • {"type": "any"}: 必须使用工具
  • {"type": "tool", "name": "tool_name"}: 使用指定工具

Response

id
string
唯一消息标识符示例:"msg_013Zva2CMHLNnXjNJJKqJ2EF"
type
string
对象类型固定为 "message"
role
string
角色固定为 "assistant"
content
array
内容块数组模型生成的内容,是一个内容块数组。文本内容:
工具使用:
内容类型:
  • text: 文本内容
  • tool_use: 工具调用
model
string
处理请求的模型示例:"claude-sonnet-4-6"
stop_reason
string
停止原因可能的值:
  • end_turn: 自然结束
  • max_tokens: 达到最大token数
  • stop_sequence: 遇到停止序列
  • tool_use: 调用了工具
stop_sequence
string | null
触发的停止序列如果因停止序列而停止,则为该序列内容;否则为 null
usage
object
Token使用统计

使用示例

基础对话

多轮对话

使用系统提示词

流式响应

工具使用

视觉理解

Base64图像

最佳实践

1. 提示词工程

清晰的角色定义:
结构化输出:

2. 错误处理

3. Token优化

4. 预填充响应

流式响应处理

Python流式示例

JavaScript流式示例

注意事项

  1. API密钥安全
    • 使用环境变量存储API密钥
    • 不要在代码中硬编码密钥
    • 定期轮换密钥
  2. 速率限制
    • 注意API的速率限制
    • 实现重试机制
    • 使用指数退避策略
  3. Token管理
    • 监控token使用量
    • 优化提示词长度
    • 使用适当的max_tokens值
  4. 模型选择
    • Opus: 复杂任务、需要深度思考
    • Sonnet: 平衡性能和成本
    • Haiku: 快速响应、简单任务
  5. 内容过滤
    • 验证用户输入
    • 过滤敏感信息
    • 实现内容审核机制