跳转到内容

认证

请求使用 API 密钥进行认证。请把密钥作为 Bearer 令牌放在 Authorization 请求头中发送:

Authorization: Bearer YOUR_API_KEY

在控制台的 API 密钥页面创建密钥。为密钥起一个名称。你也可以设置支出上限和到期日。详见余额与 API 密钥限额。

控制台只会在创建密钥后显示一次完整的密钥。密钥以 cherry_ 开头。如果丢失了密钥,请吊销它并创建新的密钥。被吊销的密钥从下一个请求起就会失效。

所有端点都从 Authorization: Bearer 请求头读取密钥。POST /v1/messages 还接受 x-api-key 请求头中的密钥,因为 Anthropic SDK 会把密钥放在那里。其他端点都不读取 x-api-key。

生成端点(对话、图像和视频)、任务端点、余额与密钥端点以及 Webhook 端点都需要 API 密钥。

以下端点无需 API 密钥:

  • GET /v1/models
  • GET /v1/models/{vendor}/{model}
  • POST /v1/estimate
  • GET /v1/files/{token} 以输出文件的签名 URL 本身作为凭证。详见任务。

没有有效密钥的请求会返回 401 和错误代码 unauthorized,响应带有 WWW-Authenticate: Bearer 响应头。无论密钥是缺失、格式有误、未知、已吊销还是已过期,返回的错误都相同,因此无法从中得知是哪一种情况。请检查是否复制了完整的密钥,必要时创建新的密钥。POST /v1/messages 以 Anthropic 的格式返回错误。详见对话。

调用 GET /v1/key 会返回发送该请求的密钥,包括名称、末四位字符、到期日、支出上限和用量。详见余额与 API 密钥限额。

终端窗口
curl "https://api.sakuranbo.ai/v1/key" \
-H "Authorization: Bearer $SAKURANBO_API_KEY"

每个响应都包含 X-Request-Id 响应头。如需与自己的日志对应,可以发送长度为 8 到 64 个字符(A-Z、a-z、0-9、_、-)的 X-Request-Id,该值将用作请求 ID。错误响应会在 error.request_id 中重复这个 ID。POST /v1/messages 则把它放在顶层的 request_id 字段中,因为它的错误采用 Anthropic 的格式。

请把密钥保存在 SAKURANBO_API_KEY 之类的环境变量中。不要放进客户端代码或公开仓库。请从你的服务器调用 API,包括 POST /v1/messages。浏览器无法向 API 发送 x-api-key 请求头,因为 API 的 CORS 规则不允许该请求头。

如需连接编码代理,请参阅 MCP 服务器。它接受 API 密钥或 OAuth 登录。