DataEyes AI — API 密钥与额度查询接口文档

文档版本：v2.1
最后更新：2026-09-29
服务区域：国际站

概述

本文介绍完整密钥获取、额度与用量查询、可用模型、用户信息及订阅查询接口。

获取完整 API 密钥，请参阅 3.2 节。

服务地址

用途	地址
模型调用与 OpenAI 兼容查询	`https://platform.dataeyes.ai`
密钥额度、用户信息及订阅查询	`https://www.dataeyes.ai/apex`
登录与完整密钥查询（3.2 节）	`https://www.dataeyes.ai/api`

各 cURL 示例均包含完整请求地址。

鉴权方式

方式一：API Key 鉴权

第一、二章的查询接口及第六章的 SDK 示例使用 API Key：

Authorization: Bearer sk-xxxxxxxxxxxxxxxx

API 密钥可在控制台的密钥管理页面中管理。

方式二：系统访问令牌鉴权

3.1 节的用户信息查询和 3.3 节的订阅查询使用系统访问令牌及用户数字 ID：

Authorization: Bearer <系统访问令牌>
apex-api-user: <用户数字ID>

系统访问令牌在控制台「个人设置 → 账户管理 → 安全设置」中查看和复制。用户数字 ID 需联系后台管理员获取。

方式三：登录令牌鉴权

3.2 节使用账号登录后返回的登录令牌，查询完整密钥时还需提交当前登录密码。

Authorization: Bearer <登录令牌>

完整密钥查询无需填写用户数字 ID 或 apex-api-user。按 3.2 节的三个步骤获取登录令牌、查询密钥 ID，再获取完整密钥。

一、OpenAI 兼容接口

以下接口使用 OpenAI 兼容格式返回计费和模型数据。

基础地址：https://platform.dataeyes.ai

1.1 查询额度上限

使用 API Key 查询额度上限。

接口地址

GET /v1/dashboard/billing/subscription

请求头

名称	必填	说明
`Authorization`	是	`Bearer <API-Key>`

请求示例

响应示例

{
  "object": "billing_subscription",
  "has_payment_method": true,
  "soft_limit_usd": 100000000,
  "hard_limit_usd": 100000000,
  "system_hard_limit_usd": 100000000,
  "access_until": 0
}

响应字段

字段	类型	说明
`object`	String	固定值 `"billing_subscription"`
`has_payment_method`	Boolean	兼容字段，返回 `true`
`soft_limit_usd`	Number	接口返回的软性额度上限，单位为美元
`hard_limit_usd`	Number	接口返回的硬性额度上限，单位为美元
`system_hard_limit_usd`	Number	系统级硬限额，与 `hard_limit_usd` 一致
`access_until`	Integer	订阅到期时间（Unix 时间戳），`0` 表示永不过期

密钥设置为无限额度时，三个限额字段均返回 100000000。该值表示密钥额度不受限制，不代表账号余额为 1 亿美元。

1.2 查询累计用量

获取累计消费金额。

接口地址

GET /v1/dashboard/billing/usage

请求头

名称	必填	说明
`Authorization`	是	`Bearer <API-Key>`

请求示例

start_date 和 end_date 参数不用于筛选结果。本接口返回累计用量，不按日期范围过滤。

响应示例

{
  "object": "list",
  "total_usage": 601.41
}

响应字段

字段	类型	说明
`object`	String	固定值 `"list"`
`total_usage`	Number	累计消费金额，单位为美分。除以 `100` 可换算为美元：`601.41` 美分 = 6.01

1.3 查询可用模型列表

获取当前 API Key 可调用的全部模型列表。

接口地址

GET /v1/models

请求头

名称	必填	说明
`Authorization`	是	`Bearer <API-Key>`

请求示例

响应示例

{
  "data": [
    {
      "id": "gpt-4o",
      "object": "model",
      "created": 1626777600,
      "owned_by": "openai",
      "supported_endpoint_types": ["openai"]
    },
    {
      "id": "claude-opus-4-6",
      "object": "model",
      "created": 1626777600,
      "owned_by": "vertex-ai",
      "supported_endpoint_types": ["openai", "anthropic"]
    },
    {
      "id": "gemini-2.5-pro-thinking",
      "object": "model",
      "created": 1626777600,
      "owned_by": "custom",
      "supported_endpoint_types": ["openai", "gemini"]
    }
  ],
  "object": "list",
  "success": true
}

响应字段

字段	类型	说明
`data`	Array	模型列表
`data[].id`	String	模型标识符，调用时使用此值
`data[].object`	String	固定值 `"model"`
`data[].created`	Integer	接口返回的创建时间，Unix 秒级时间戳
`data[].owned_by`	String	接口返回的所有者或提供方标识，如 `openai`、`vertex-ai`、`custom`
`data[].supported_endpoint_types`	Array	支持的调用格式：`openai`、`anthropic`、`gemini`、`image-generation`、`embeddings`、`rerank` 等
`object`	String	固定值 `"list"`
`success`	Boolean	请求是否成功

二、平台专属接口

本接口用于查询单个 API 密钥的额度、用量和模型限制。

基础地址：https://www.dataeyes.ai/apex

2.1 查询 API 密钥额度与用量

查询请求头中 API Key 对应的额度分配、已用额度、剩余额度和模型限制。

接口地址

GET /api/usage/token/

请求头

名称	必填	说明
`Authorization`	是	`Bearer <API-Key>`

请求示例

响应示例（有限额度）

{
  "code": true,
  "message": "ok",
  "data": {
    "object": "token_usage",
    "name": "my-production-key",
    "total_granted": 5000000,
    "total_used": 20,
    "total_available": 4999980,
    "unlimited_quota": false,
    "model_limits": {},
    "model_limits_enabled": false,
    "expires_at": 0
  }
}

响应示例（无限额度）

{
  "code": true,
  "message": "ok",
  "data": {
    "object": "token_usage",
    "name": "default-key",
    "total_granted": 500000,
    "total_used": 3007043,
    "total_available": -2507043,
    "unlimited_quota": true,
    "model_limits": {},
    "model_limits_enabled": false,
    "expires_at": 0
  }
}

响应字段

字段	类型	说明
`code`	Boolean	请求是否成功，`true` 表示成功
`message`	String	状态描述，成功时为 `"ok"`
`data.object`	String	固定值 `"token_usage"`
`data.name`	String	API Key 备注名称
`data.total_granted`	Integer	总分配额度（内部单位）。换算公式：`÷ 500,000 = 美元`
`data.total_used`	Integer	已消耗累计额度（内部单位）
`data.total_available`	Integer	剩余可用额度（`total_granted − total_used`）
`data.unlimited_quota`	Boolean	是否不限制密钥额度；不代表账号余额无限
`data.model_limits`	Object	模型访问限制规则。空对象 `{}` 表示无限制
`data.model_limits_enabled`	Boolean	是否启用模型级访问控制
`data.expires_at`	Integer	Key 过期时间（Unix 时间戳），`0` 表示永不过期

额度换算公式

美元金额 = 内部额度值 ÷ 500,000

内部额度值	对应美元	计算过程
`5,000,000`	$10.00	5000000 ÷ 500000 = 10
`3,007,043`	$6.01	3007043 ÷ 500000 ≈ 6.01
`500,000`	$1.00	500000 ÷ 500000 = 1

当 unlimited_quota 为 true 时，total_available 可能为负值，表示累计消耗超过分配额度。不能仅凭该负值判断密钥额度已耗尽。

三、账号与 API 密钥查询

本章介绍用户信息、完整 API 密钥和订阅查询。各请求的地址与鉴权方式见对应示例。

3.1 获取用户信息

使用系统访问令牌和用户数字 ID 查询账号详情。

接口地址

GET /api/user/self

请求头

名称	必填	说明
`Authorization`	是	`Bearer <系统访问令牌>`
`apex-api-user`	是	与系统访问令牌对应的用户数字 ID

请求示例

响应示例

{
  "success": true,
  "message": "",
  "data": {
    "id": 669,
    "username": "example_user",
    "display_name": "example_user",
    "email": "user@example.com",
    "role": 1,
    "status": 1,
    "group": "pro",
    "quota": 4084864,
    "used_quota": 269527941,
    "request_count": 9412,
    "aff_code": "xxxx",
    "aff_count": 0,
    "aff_quota": 0,
    "aff_history_quota": 0,
    "inviter_id": 0
  }
}

响应字段（data 对象）

字段	类型	说明
`id`	Integer	用户数字 ID
`username`	String	登录用户名
`display_name`	String	显示名称
`email`	String	注册邮箱
`role`	Integer	用户角色。`1` = 普通用户，`10` = 管理员，`100` = 超级管理员
`status`	Integer	账户状态。`1` = 正常，`2` = 已禁用
`group`	String	用户所属计费分组
`quota`	Integer	账户级剩余额度（内部单位，÷500000 = 美元）
`used_quota`	Integer	账户级已消耗总额度
`request_count`	Integer	API 累计请求次数
`aff_code`	String	推荐码
`aff_count`	Integer	已推荐用户数
`aff_quota`	Integer	待发放推荐奖励额度
`aff_history_quota`	Integer	历史累计推荐奖励总额
`inviter_id`	Integer	邀请人用户 ID，`0` 表示无邀请人

3.2 查询完整 API 密钥

准备账号、登录密码和密钥名称，依次调用以下接口。示例中的尖括号占位符需替换为实际值，填写时不保留尖括号。

步骤	请求	获取的字段
1. 登录	`POST /api/client/login`	`data.token`：登录令牌
2. 查询密钥 ID	`GET /api/apex/api/token/search`	`data.items[].id`：密钥 ID
3. 查询完整密钥	`POST /api/client/token/plain`	`data.key`：完整 API 密钥

尚未设置登录密码的账号，请先登录控制台，在密钥管理页面点击密钥的「查看」，按「设置登录密码」弹窗提示设置密码。

第一步：登录

接口地址

POST https://www.dataeyes.ai/api/client/login

请求头

请求头	必填	说明
`Content-Type`	是	`application/json`

请求体参数

参数	类型	必填	说明
`account`	String	是	用于登录国际站的邮箱或手机号；手机号使用与登录页面一致的国家区号，不含空格
`password`	String	是	当前账号的登录密码

cURL 请求示例

成功响应示例（节选）

{
  "code": 0,
  "data": {
    "token": "<登录令牌>"
  },
  "msg": ""
}

响应字段

字段	类型	说明
`code`	Integer	`0` 表示登录成功
`data.token`	String	登录令牌，用于后续请求
`msg`	String	响应提示

code 为 0 时，复制完整的 data.token，不包含两侧的双引号。其他账号信息无需复制。

第二步：查询密钥 ID

按密钥名称搜索，无需提前知道密钥 ID。

接口地址

GET https://www.dataeyes.ai/api/apex/api/token/search

请求头

请求头	必填	说明
`Authorization`	是	`Bearer <登录令牌>`，使用第一步返回的 `data.token`

查询参数

参数	类型	必填	说明
`keyword`	String	本示例必填	要查询的密钥完整名称
`p`	Integer	否	页码，从 `1` 开始，本例传入 `1`
`size`	Integer	否	每页条数，本例传入 `20`

cURL 请求示例

将 <密钥名称> 替换为实际的密钥名称，例如 default。

如果不知道密钥名称，可先查询当前账号的密钥列表：

成功响应示例（节选）

{
  "success": true,
  "message": "",
  "data": {
    "page": 1,
    "page_size": 20,
    "total": 1,
    "items": [
      {
        "id": 12345,
        "name": "default"
      }
    ]
  }
}

响应字段

字段	类型	说明
`success`	Boolean	`true` 表示查询成功
`message`	String	响应提示
`data.page`	Integer	当前页码
`data.page_size`	Integer	每页条数
`data.total`	Integer	符合条件的密钥总数
`data.items[].id`	Integer	密钥 ID，第三步作为 `token_id` 提交
`data.items[].name`	String	密钥名称

找到名称匹配的记录，将其 id 填入第三步的 token_id。例如，上面的 default 对应 12345；实际请求时请使用你查询到的 ID。

有同名密钥时，需结合创建时间和配置信息确认记录。结果超过一页时，增加 p 翻页；data.items 为空表示本页没有记录。

列表或搜索结果中的 key 为脱敏值。完整密钥通过第三步获取。

其他密钥字段

列表和搜索响应还可能包含以下字段，第三步请求无需提交这些字段。

`data.items[]` 中的字段	类型	说明
`user_id`	Integer	密钥所属用户的数字 ID
`key`	String	脱敏密钥，不能用于模型调用
`status`	Integer	`1` = 启用，`2` = 禁用，`3` = 已过期，`4` = 额度已耗尽
`created_time`	Integer	创建时间，Unix 秒级时间戳
`accessed_time`	Integer	最后访问时间，Unix 秒级时间戳
`expired_time`	Integer	过期时间，Unix 秒级时间戳；`-1` 表示永不过期
`remain_quota`	Integer	密钥剩余额度，使用内部额度单位
`unlimited_quota`	Boolean	是否不限制密钥额度
`used_quota`	Integer	已消耗额度，使用内部额度单位
`model_limits_enabled`	Boolean	是否启用密钥的模型限制
`model_limits`	String	已配置的模型限制
`allow_ips`	String	允许访问的 IP 地址；为空表示不限制该密钥的访问 IP
`group`	String	密钥配置的分组
`cross_group_retry`	Boolean	是否启用跨分组重试

第三步：查询完整密钥

使用第一步的登录令牌，提交第二步的密钥 ID 和当前登录密码。

接口地址

POST https://www.dataeyes.ai/api/client/token/plain

请求头

请求头	必填	说明
`Authorization`	是	`Bearer <登录令牌>`，使用第一步返回的 `data.token`
`Content-Type`	是	`application/json`

请求体参数

参数	类型	必填	说明
`token_id`	Integer	是	第二步返回的密钥 `id`
`password`	String	是	当前账号的登录密码

cURL 请求示例

将 12345 替换为第二步取得的 ID。本请求使用 POST，请求体使用 JSON。

成功响应示例

{
  "code": 0,
  "data": {
    "key": "sk-<完整密钥内容>"
  },
  "msg": ""
}

响应字段

字段	类型	说明
`code`	Integer	`0` 表示查询成功
`data.key`	String	完整 API 密钥，已包含 `sk-` 前缀，可直接用于模型调用
`msg`	String	响应提示，成功时为空字符串

复制完整的 data.key，不包含两侧的双引号，也不要再添加 sk- 前缀。模型调用的请求头填写如下：

Authorization: Bearer <data.key 的完整值>

同一把密钥可以重复查询，每次均需提交登录密码。请勿将密码、登录令牌或完整密钥写入日志或代码仓库。

3.3 获取订阅信息

使用系统访问令牌和用户数字 ID 查询订阅详情。

接口地址

GET /api/subscription/self

请求头

名称	必填	说明
`Authorization`	是	`Bearer <系统访问令牌>`
`apex-api-user`	是	与系统访问令牌对应的用户数字 ID

请求示例

响应示例

{
  "success": true,
  "message": "",
  "data": {
    "subscriptions": [],
    "all_subscriptions": [],
    "billing_preference": "subscription_first"
  }
}

响应字段

字段	类型	说明
`data.subscriptions`	Array	当前生效的订阅计划
`data.all_subscriptions`	Array	全部订阅计划（含已过期）
`data.billing_preference`	String	计费优先级。`"subscription_first"` = 优先使用订阅额度

四、接口选择指南

用途	章节	鉴权方式
查询额度上限	1.1	API Key
查询累计消费金额	1.2	API Key
查询可用模型	1.3	API Key
查询单个密钥的额度与用量（内部单位）	2.1	API Key
查询用户信息	3.1	系统访问令牌和用户数字 ID
获取完整 API 密钥	3.2	账号密码登录；查询时使用登录令牌和密码
查询订阅信息	3.3	系统访问令牌和用户数字 ID

五、错误码参考

HTTP 200 不代表业务成功，还需检查响应内容：

请求	成功条件
登录	`code` 为整数 `0`，且返回 `data.token`
完整密钥查询	`code` 为整数 `0`，且返回 `data.key`
密钥额度与用量查询（2.1 节）	`code` 为布尔值 `true`
用户信息、密钥搜索与列表、订阅查询	`success` 为 `true`，并返回对应数据
OpenAI 兼容查询	HTTP 2xx，返回预期字段，且不包含 `error` 对象

错误消息可能随语言设置变化。通过状态字段判断失败，再查看 msg、message 或 error.message 中的原因。

场景	响应	处理方式
未提供 API Key	HTTP 401	添加 `Authorization: Bearer <API-Key>` 请求头
登录参数校验失败	`code` 非 `0`，`msg` 返回原因	检查账号格式和当前登录密码
登录要求额外验证	登录响应提示需要额外验证	在网站完成验证，不要反复提交相同的 cURL 请求
登录令牌缺失或已失效	`code: 401`，`msg` 返回原因	重新登录，用新的 `data.token` 更新请求头
系统访问令牌鉴权失败	`code: 401`，`msg` 返回原因	检查系统访问令牌及其对应的用户数字 ID
搜索无结果	`success: true`，结果为空	检查密钥名称和页码，或使用第二步的列表查询
查询完整密钥时未提交密码	`code: 400`，不返回密钥	在 JSON 请求体中填写 `password`
账号未设置登录密码	点击「查看」后弹出「设置登录密码」窗口	在控制台设置密码后，按 3.2 节查询
完整密钥查询失败	`code` 非 `0`，`msg` 返回原因	检查登录令牌、`token_id` 和当前登录密码
请求地址或方法错误	HTTP 404	登录和完整密钥查询使用 POST，搜索使用 GET；核对完整地址
分组无权限	消息提示分组权限问题	检查密钥配置的分组及可用模型

六、SDK 集成示例

将示例中的 API Key 替换为完整密钥，model 填写该密钥调用 /v1/models 返回的模型 ID。

Python（OpenAI SDK）

JavaScript / TypeScript（OpenAI SDK）

七、使用建议

业务允许时，可将额度查询结果缓存 30–60 秒。

只读查询因临时网络故障失败时，稍后重试；若是鉴权错误，先检查凭据。

需要分别统计用量的业务使用不同密钥。

对 unlimited_quota 为 false 的密钥，在 total_available 低于设定阈值时触发告警。

妥善保存 API 密钥，不要将密码、登录令牌或完整密钥写入应用日志或代码仓库。

变更记录

版本	日期	说明
v2.1	2026-09-29	增加密码验证的完整密钥查询流程，补充登录、密钥 ID 获取、请求参数和响应示例

API 密钥与额度查询接口

DataEyes AI — API 密钥与额度查询接口文档#

概述#

服务地址#

鉴权方式#

方式一：API Key 鉴权#

方式二：系统访问令牌鉴权#

方式三：登录令牌鉴权#

一、OpenAI 兼容接口#

1.1 查询额度上限#

1.2 查询累计用量#

1.3 查询可用模型列表#

二、平台专属接口#

2.1 查询 API 密钥额度与用量#

三、账号与 API 密钥查询#

3.1 获取用户信息#

3.2 查询完整 API 密钥#

第一步：登录#

第二步：查询密钥 ID#

第三步：查询完整密钥#

3.3 获取订阅信息#

四、接口选择指南#

五、错误码参考#

六、SDK 集成示例#

Python（OpenAI SDK）#

JavaScript / TypeScript（OpenAI SDK）#

七、使用建议#

变更记录#

DataEyes AI — API 密钥与额度查询接口文档

概述

服务地址

鉴权方式

方式一：API Key 鉴权

方式二：系统访问令牌鉴权

方式三：登录令牌鉴权

一、OpenAI 兼容接口

1.1 查询额度上限

1.2 查询累计用量

1.3 查询可用模型列表

二、平台专属接口

2.1 查询 API 密钥额度与用量

三、账号与 API 密钥查询

3.1 获取用户信息

3.2 查询完整 API 密钥

第一步：登录

第二步：查询密钥 ID

第三步：查询完整密钥

3.3 获取订阅信息

四、接口选择指南

五、错误码参考

六、SDK 集成示例

Python（OpenAI SDK）

JavaScript / TypeScript（OpenAI SDK）

七、使用建议

变更记录