概览
在 API 设计最终敲定之前,v2 端点当前使用
/api/v2alpha 前缀提供服务。基础 URL 为 https://server.codeium.com。v2 的新变化
| v1 分析 API | v2 分析 API | |
|---|---|---|
| 传输 | 使用 JSON 请求体的 POST | 带查询参数的 GET |
| 身份验证 | 请求体中的 service_key 字段 | Authorization: Bearer <service_key> 标头 |
| 权限 | 因端点而异 | Analytics Read |
| 分页 | 无 | 基于游标 (next_page_cursor / page_cursor) |
| 缓存 | 无 | ETag + If-None-Match (304 Not Modified) |
身份验证
Authorization 标头中,而不是放在请求体中:
创建服务密钥
- 前往你的团队设置
- 进入“Service Keys”部分
- 创建一个具有 Analytics Read 权限的新服务密钥
- 将该密钥作为 Bearer 令牌放在
Authorization标头中
可用端点
计费策略
metadata.billing_strategy 中返回:
CREDITS— 行中包含prompt_credits和flex_creditsACU— 行中包含billed_acus
message_count 字段。
分页
pagination.next_page_cursor;将其作为 page_cursor 查询参数传回,以获取下一
页。游标会在 24 小时后失效。
缓存
ETag 标头。在后续请求中,通过 If-None-Match 标头将其发回;
如果数据未发生变化,则会收到 304 Not Modified。
速率限制
429 Too Many Requests,并附带 Retry-After 标头。
对先前查询的分页请求 (沿用 next_page_cursor) 不会计入速率
限制——只有每份报告的初始查询才会计入。较低的限制也说明这些端点
用于定期报告,而非实时监控。