Skip to main content
Venice API 请求使用 Bearer API 密钥进行身份验证。本指南介绍如何从 Venice 仪表板创建密钥、安全地存储它,并验证其是否可用。
如果你正在构建一个需要使用钱包自行铸造密钥的自主代理,请改为参考 自主代理 API 密钥创建 指南。

​
开始之前

  • 登录你的 Venice 账户。
  • 在调用付费端点之前,请确保账户拥有可用余额。你可以在为账户充值之前创建密钥,但在账户能够消费 DIEM、捆绑积分或 USD 之前,模型请求将无法成功。
1

打开 API 设置

访问 https://venice.ai/settings/api。你也可以在 Venice 应用中通过设置里选择 API 打开此页面。API 设置仪表板会显示你的余额、API 等级、使用情况以及现有的 API 密钥。
2

开始创建新密钥

选择 Generate New API Key,然后配置密钥:
  • Description: 使用一个能够标识将使用此密钥的应用、环境或集成的简短名称。
  • API Key Type: 对于常规模型请求使用 Inference Only。仅当密钥需要以编程方式管理 API 密钥时才使用 Admin。
  • Expires at: 可选地设置过期日期。如果留空,该密钥不会自动过期。
  • Epoch Consumption Limits: 可选地限制此密钥在 24 小时周期内可以消费的 DIEM 或 USD 数量。如果留空,该密钥可使用账户的可用余额,并受账户限制的约束。
3

生成并复制密钥

点击 Generate。Venice 将一次性显示完整的 API 密钥。
请立即复制密钥并将其存储在安全位置。在关闭对话框后,Venice 仅会显示标识性的元数据,例如密钥描述和最后几位字符。如果你丢失了密钥值,请删除该密钥并创建一个新的。
将密钥添加到本地环境或密钥管理器中:
4

验证密钥

发起一个低风险的请求以确认身份验证正常工作:
成功的响应会返回可用模型列表。如果收到身份验证错误,请确认密钥已被完整复制,并且 Authorization 头的格式为 Bearer <api-key>。
在 Venice 应用中创建 API 密钥时禁用 USD 支出会将该 API 密钥的 USD 支出上限设置为零。当您可用的 DIEM 或捆绑积分无法支付请求时,API 调用可能会因余额不足错误而失败,即使您的账户中有 USD 余额也是如此。

​
排查支出限额错误

每个密钥的支出限额与账户余额是相互独立的。即使账户中仍有已充值的 USD 积分、DIEM 或捆绑积分,某个密钥仍可能因自身限额而被阻止消费。如果请求返回 402 状态码,并附带以下代码之一,则原因是该密钥自身的限额,而非账户余额:
  • API_KEY_USD_SPEND_LIMIT_EXCEEDED — 该密钥的 USD 支出限额被设置为零(创建时禁用了 USD 支出),或当前周期已达到 USD 上限。
  • API_KEY_DIEM_SPEND_LIMIT_EXCEEDED — 该密钥在当前 24 小时周期内已达到 DIEM 上限。
要确认某个密钥的当前状态,请调用 获取 API 密钥速率限制和余额,并查看 data.accessPermitted、data.balances 以及每个密钥的消费限额。 要解决该错误,可以在 venice.ai/settings/api 中调高或移除该密钥的 Epoch Consumption Limits,或使用新的 consumptionLimits 调用 更新 API 密钥。账户级别的余额(USD、DIEM 和捆绑积分)是独立的支付来源,系统会在有可用余额时自动扣除;你无需在请求时选择使用哪一种。 有关计费相关响应的完整列表,请参见 错误代码。

​
最佳实践

  • 为开发、预发布和生产环境创建独立的密钥。
  • 对于仅调用模型端点的应用,优先使用 Inference Only 密钥。
  • 让 Admin 密钥保持稀少、严格受限,并仅存储在受信任的服务器端环境中。
  • 切勿将 API 密钥提交到源代码管理系统,或暴露在客户端代码中。
  • 对于在临时、共享或高风险环境中使用的密钥,请设置过期日期和消费限额。
  • 删除未使用的密钥,并轮换可能已被泄露的任何密钥。

​
以编程方式管理密钥

Admin 密钥可以通过 API 参考端点管理 API 密钥:

创建 API 密钥

使用现有的 admin 密钥创建一个新的仪表板风格 API 密钥。

列出 API 密钥

查看活跃的密钥及其元数据。

更新 API 密钥

更新密钥的描述、过期日期或消费限额。

删除 API 密钥

撤销不再需要的密钥。