使用管理 API

一些企业用户可能更喜欢通过编程方式管理其账户详细信息，而不是通过 xAI 控制台手动管理。为此，我们开发了管理 API，使企业用户能够高效地管理其团队详细信息。

您可以在管理 API 参考中阅读端点规范和描述。

您需要获取一个管理密钥才能使用管理 API，该密钥与您的 API 密钥是分开的。管理密钥可以在xAI 控制台中获取。

基本 URL 为https://management-api.x.ai，这也与推理 API 不同。

您可以通过管理 API 创建、列出、更新和删除 API 密钥。

您还可以管理与 API 密钥相关的访问控制列表（ACL）。

可用的 ACL 类型有

要启用团队所有可用的模型和端点，请使用

或者，如果您需要指定 API 可用的特定端点

并指定 API 密钥可访问的模型

一个创建 API 密钥的示例，其中启用了所有模型和端点，将请求限制为每秒 5 次查询和每分钟 100 次查询，没有令牌数量限制。

将tpm指定为任何整数字符串，以限制每分钟生成/消耗的令牌数量。当令牌速率限制触发时，新请求将被拒绝，正在进行的请求将继续处理。

新创建的 API 密钥将在响应对象的"apiKey"字段中返回。API 密钥 ID 也将在响应体中以"apiKeyId"的形式返回，这对于更新和删除操作非常有用。

要从团队中检索 API 密钥列表，您可以运行以下命令

您可以自定义查询参数，例如pageSize和paginationToken。

您可以在 API 密钥创建后对其进行更新。例如，更新 API 密钥的qpm

或者更新 API 密钥的name

您还可以通过以下方式删除 API 密钥

在创建 API 密钥和 API 密钥可在所有集群中使用之间可能会有轻微延迟。

您可以通过 API 检查 API 密钥的传播状态。

您也可以使用我们的管理 API 列出团队所有可用的模型。

输出中的模型名称可用于在 API 密钥上设置 ACL 字符串，例如api-key:model:<model-name>

访问控制列表 (ACL) 管理

我们还提供端点来列出团队可能的 ACL。然后，您可以将端点 ACL 字符串应用于您的 API 密钥。

查看团队 API 密钥的可能端点 ACL