> ## Documentation Index
> Fetch the complete documentation index at: https://veniceai-mintlify-d2fddb8a.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 生成 API 密钥

> 从仪表板创建 Venice API 密钥、安全地存储 bearer token，并通过首次经过身份验证的 chat completions 请求验证其可用。

Venice API 请求使用 Bearer API 密钥进行身份验证。本指南介绍如何从 Venice 仪表板创建密钥、安全地存储它,并验证其是否可用。

<Note>
  如果你正在构建一个需要使用钱包自行铸造密钥的自主代理,请改为参考 [自主代理 API 密钥创建](/guides/getting-started/generating-api-key-agent) 指南。
</Note>

## 开始之前

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

<Steps>
  <Step title="打开 API 设置">
    访问 [https://venice.ai/settings/api](https://venice.ai/settings/api)。你也可以在 Venice 应用中通过设置里选择 **API** 打开此页面。

    API 设置仪表板会显示你的余额、API 等级、使用情况以及现有的 API 密钥。
  </Step>

  <Step title="开始创建新密钥">
    选择 **Generate New API Key**,然后配置密钥:

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

  <Step title="生成并复制密钥">
    点击 **Generate**。Venice 将一次性显示完整的 API 密钥。

    <Warning>
      请立即复制密钥并将其存储在安全位置。在关闭对话框后,Venice 仅会显示标识性的元数据,例如密钥描述和最后几位字符。如果你丢失了密钥值,请删除该密钥并创建一个新的。
    </Warning>

    将密钥添加到本地环境或密钥管理器中:

    ```bash theme={null}
    export VENICE_API_KEY="your-api-key-here"
    ```
  </Step>

  <Step title="验证密钥">
    发起一个低风险的请求以确认身份验证正常工作:

    ```bash theme={null}
    curl --request GET \
      --url https://api.venice.ai/api/v1/models \
      --header "Authorization: Bearer $VENICE_API_KEY"
    ```

    成功的响应会返回可用模型列表。如果收到身份验证错误,请确认密钥已被完整复制,并且 `Authorization` 头的格式为 `Bearer <api-key>`。
  </Step>
</Steps>

## 最佳实践

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

## 以编程方式管理密钥

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

<CardGroup cols={2}>
  <Card title="创建 API 密钥" icon="plus" href="/api-reference/endpoint/api_keys/create">
    使用现有的 admin 密钥创建一个新的仪表板风格 API 密钥。
  </Card>

  <Card title="列出 API 密钥" icon="list" href="/api-reference/endpoint/api_keys/list">
    查看活跃的密钥及其元数据。
  </Card>

  <Card title="更新 API 密钥" icon="pen-to-square" href="/api-reference/endpoint/api_keys/update">
    更新密钥的描述、过期日期或消费限额。
  </Card>

  <Card title="删除 API 密钥" icon="trash" href="/api-reference/endpoint/api_keys/delete">
    撤销不再需要的密钥。
  </Card>
</CardGroup>