跳转到主要内容

请求地址

鉴权与协议版本

使用 ViVi-API API Key。本文按 2023-06-01 版本展示 Messages 基础格式;如模型或接入渠道要求其他版本,请按要求调整,不能仅因上游新增版本就假设网关已支持。
YOUR_ANTHROPIC_MODEL 是占位符,请替换为账号实际可用、支持 Anthropic Messages 协议的完整模型 ID。

请求参数

系统指令放在顶层 system 中,不要在 messages 里添加 role: "system"。启用思考、工具等高级能力前,请确认模型及接入渠道支持情况。

调用示例

先设置环境变量 VIVI_API_KEY,方法见快速开始。cURL 使用 Bash 语法。
Python 示例需先执行 python -m pip install requests。

返回结果

以下为结构示意。content 是内容块数组,业务代码应按 type 读取。
若使用工具,可能收到 tool_use 内容块和对应停止原因;不要将其当作普通文本。

系统指令与多轮对话

每次请求都需要发送必要的历史消息;模型的上下文长度与输出上限依所选模型而定。

流式输出

常见事件顺序为 message_start → content_block_start → content_block_delta → content_block_stop → message_delta → message_stop。中间可能穿插 ping 或错误事件。
仅在 delta.type 为 text_delta 时读取 delta.text。工具参数、思考等增量具有其他结构;发生流中错误时,即使最初 HTTP 状态为 200,也应按失败处理。

接入提示

  • max_tokens 是必填参数。
  • 版本号写在 anthropic-version 请求头中。
  • 返回文本位于 content 数组中,不是 choices[0].message.content。
  • 接入失败时,查看返回的错误正文,并对照错误排查。
协议参考:Anthropic Messages · API 版本说明。ViVi-API 的模型范围与可选功能以实际服务为准。