Claude API
  1. 消息
Claude API
  • API 参考
    • 入门指南
    • IP 地址
    • 版本
    • 错误
    • 速率限制
    • 客户端 SDK
    • 支持地区
    • 获取帮助
    • 亚马逊 BEDROCK API
      • Amazon Bedrock API
    • Vertex AI
      • Vertex AI API
    • 消息
      • 流式消息
      • 从文本补全迁移
      • 消息示例
      • 消息
        POST
      • 计算消息令牌数
        POST
    • 模型
      • 列出模型
      • 获取模型
    • 消息批次
      • 消息批次示例
      • 创建消息批次
      • 检索消息批次
      • 获取消息批次结果
      • 列出消息批次
      • 取消消息批次
      • 删除消息批次
    • 文本补全(传统)
      • 流式文本补全
      • 提示验证
      • 创建文本补全
    • 管理员 API
      • 组织成员管理
        • 获取用户
        • 列出用户
        • 更新用户
        • 移除用户
      • 组织邀请
        • 获取邀请
        • 列出邀请
        • 创建邀请
        • 删除邀请
      • 工作区管理
        • 获取工作区
        • 列出工作区
        • 更新工作区
        • 创建工作区
        • 归档工作区
      • 工作区成员管理
        • 获取工作区成员
        • 列出工作空间成员
        • 添加工作区成员
        • 更新工作空间成员
        • 删除工作区成员
      • API 密钥
        • 获取API密钥
        • 列出API密钥
        • 更新API密钥
  1. 消息

消息示例

消息 API 的请求和响应示例
完整的可用参数文档请参见 API 参考。

基本请求和响应#

Shell#

JSON#

{
  "id": "msg_01XFDUDYJgAACzvnptvVoYEL",
  "type": "message",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "Hello!"
    }
  ],
  "model": "claude-3-5-sonnet-20241022",
  "stop_reason": "end_turn",
  "stop_sequence": null,
  "usage": {
    "input_tokens": 12,
    "output_tokens": 6
  }
}

多轮对话#

消息 API 是无状态的,这意味着你始终需要向 API 发送完整的对话历史。你可以使用这种模式来逐步建立对话。早期的对话轮次不一定需要实际来自 Claude — 你可以使用合成的 assistant 消息。
Shell

Python#

TypeScript#

JSON#

{
    "id": "msg_018gCsTGsXkYJVqYPxTgDHBU",
    "type": "message",
    "role": "assistant",
    "content": [
        {
            "type": "text",
            "text": "Sure, I'd be happy to provide..."
        }
    ],
    "stop_reason": "end_turn",
    "stop_sequence": null,
    "usage": {
      "input_tokens": 30,
      "output_tokens": 309
    }
}

引导 Claude 的回答#

你可以在输入消息列表的最后位置预填充 Claude 的部分回答。这可以用来引导 Claude 的回应。下面的示例使用 "max_tokens": 1 来从 Claude 获取单个选择题答案。

Shell#

JSON#

{
  "id": "msg_01Q8Faay6S7QPTvEUUQARt7h",
  "type": "message",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "C"
    }
  ],
  "model": "claude-3-5-sonnet-20241022",
  "stop_reason": "max_tokens",
  "stop_sequence": null,
  "usage": {
    "input_tokens": 42,
    "output_tokens": 1
  }
}

视觉功能#

Claude 可以在请求中读取文本和图像。目前,我们支持图像的 base64 源类型,以及 image/jpeg、image/png、image/gif 和 image/webp 媒体类型。更多详情请参见我们的视觉指南。

Shell#

JSON#

{
  "id": "msg_01EcyWo6m4hyW8KHs2y2pei5",
  "type": "message",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "This image shows an ant, specifically a close-up view of an ant. The ant is shown in detail, with its distinct head, antennae, and legs clearly visible. The image is focused on capturing the intricate details and features of the ant, likely taken with a macro lens to get an extreme close-up perspective."
    }
  ],
  "model": "claude-3-5-sonnet-20241022",
  "stop_reason": "end_turn",
  "stop_sequence": null,
  "usage": {
    "input_tokens": 1551,
    "output_tokens": 71
  }
}

工具使用、JSON 模式和计算机使用(测试版)#

有关如何使用消息 API 使用工具的示例,请参见我们的指南。 有关如何使用消息 API 控制桌面计算机环境的示例,请参见我们的计算机使用(测试版)指南。
修改于 2025-02-25 08:42:48
上一页
从文本补全迁移
下一页
消息
Built with