Janvia

入门

鉴权与 API 密钥

怎么在请求里带上密钥,以及每个密钥能单独设置哪些限制。

带上密钥

每个请求都要在 Header 里带上 API 密钥,下面两种写法任选一种:

Authorization: Bearer sk_xxx
x-api-key: sk_xxx

密钥无效或缺失时返回 401 unauthorized。

GET /v1/models 是公开接口,不需要密钥。

密钥设置

在控制台的 API 密钥 页,可以给每个密钥单独设置:

  • 有效期:过期后密钥失效。
  • 允许的模型:只能调用列出的模型,调用其他模型返回 403 forbidden。
  • IP 白名单:只接受来自这些 IP 的请求。
  • 消费上限:这个密钥累计最多花多少美元,用完返回 402 key_quota_exceeded。
  • 线路偏好:排序方式、不用的线路、按参数分线路的例外规则、单次最高价,见 线路与路由。

安全建议

  • 密钥只在你的服务端使用,不要写进网页、App 或公开的代码仓库。
  • 不同项目用不同的密钥,方便单独设上限、单独停用。
  • 怀疑泄露时,删除这个密钥,再创建一个新的。