API 概述
网关提供的所有端点、各端点使用的格式及其返回内容。
三个端点。两种请求格式。一个密钥。
| 方法 | 路径 | 格式 | 用途 |
|---|---|---|---|
| POST | /v1/messages | Anthropic Messages | 聊天补全,Anthropic 封装格式 |
| POST | /v1/chat/completions | OpenAI 聊天补全 | 聊天补全,使用 OpenAI 封装格式 |
| GET | /v1/models | OpenAI 风格的列表 | 你的密钥可调用的模型 ID |
机器可读的描述发布于 /openapi.json,整个网站的纯文本摘要发布于 /llms.txt 和 /llms-full.txt.
选择端点
它们提供对 相同模型的访问,价格也相同。根据客户端已经使用的输出格式来选择,无需自行转换格式。
| 端点 | 认证请求头 | 响应结构 | 流式传输 |
|---|---|---|---|
/v1/messages | x-api-key 或 Bearer | content[] 数组 + usage | SSE, content_block_delta 事件 |
/v1/chat/completions | Bearer | choices[].message.content | SSE, choices[].delta.content 数据块 |
流式响应的结构不同,不能互换。为以下格式编写的客户端:
choices[].delta.content 将无法从 Messages 流中读取任何内容。请参阅 流式传输.通用请求头
| 请求头 | 适用范围 | 备注 |
|---|---|---|
content-type: application/json | 两个 POST 请求 | 必填 |
x-api-key | Messages | Anthropic 风格 |
Authorization: Bearer | 两者 | OpenAI 风格;Messages 也接受此格式 |
anthropic-version: 2023-06-01 | Messages | 由 Anthropic SDK 自动设置 |
accept: text/event-stream | 两者 | 由 SDK 设置,条件是 stream 为 true |