Skip to content

平台开放接口

平台开放接口面向企业认证用户大客户套餐用户,用于以编程方式管理账号下的 API 密钥、查询余额与用量。

调用地址https://api.openai-proxy.org

认证

所有接口走 HTTP Bearer 鉴权,请求头加:

Authorization: Bearer sk-admin-xxxxxxxxxxxx

sk-admin- 开头的管理密钥在控制台「开发者模式 → 秘钥管理 → 管理密钥」中创建。管理密钥不能用于模型调用,API 密钥(sk- 开头)也不能用于本组接口,两者权限互不重叠。

注意:管理秘钥权限较高,强烈建议配置IP白名单进行保护。

错误响应

所有错误统一为如下结构(HTTP 状态码非 2xx 时):

json
{ "error": { "code": "<错误码>", "message": "<可读描述>" } }

常见状态码:400 请求参数错误 · 401 未认证 · 404 资源不存在 · 500 服务端错误。文档中各接口只展示 200 成功响应,其它非 2xx 一律遵循上述错误结构。

创建 API 密钥

POST
/api/v1/management/api-key/create

新建一个 API 密钥用于模型调用(管理秘钥仅支持网页端创建)。

  • 出于安全考虑,新建的密钥仅返回一次,创建后无法通过任何 API 再次获取,需要自行保存。
  • 如果密钥遗失,可登录控制台「开发者模式 → 秘钥管理」页面查看找回。

字段:

  • alias 必填,密钥的可读标签
  • security_config 可省略;省略 = 不限制

限流:60 次/分钟

Request Body

application/json
JSON
{
  
"alias": "生产环境-后端调用"
}

Responses

创建成功

application/json
JSON
{
  
"key": "sk-xxxxxxxxxxxx",
  
"alias": "生产环境-后端调用",
  
"enabled": true,
  
"security_config": {
  
  
"ip": {
  
  
  
"allow": [
  
  
  
  
"1.2.3.4"
  
  
  
]
  
  
},
  
  
"spend_limit": {
  
  
  
"monthly": 500
  
  
},
  
  
"geo": {
  
  
  
"countries": [
  
  
  
  
"CN"
  
  
  
]
  
  
},
  
  
"models": {
  
  
  
"mode": "model",
  
  
  
"items": [
  
  
  
  
"gpt-4o"
  
  
  
]
  
  
}
  
},
  
"created_at": "2026-05-30T08:30:00Z"
}

查询 API 密钥详情

POST
/api/v1/management/api-key/get

查询 API 密钥的当前配置。

限流:600 次/分钟

Request Body

application/json
JSON
{
  
"key": "sk-xxxxxxxxxxxx"
}

Responses

查询成功

application/json
JSON
{
  
"alias": "生产环境-后端调用",
  
"enabled": true,
  
"security_config": {
  
  
"ip": {
  
  
  
"allow": [
  
  
  
  
"1.2.3.4"
  
  
  
]
  
  
},
  
  
"spend_limit": {
  
  
  
"monthly": 500
  
  
},
  
  
"geo": {
  
  
  
"countries": [
  
  
  
  
"CN"
  
  
  
]
  
  
},
  
  
"models": {
  
  
  
"mode": "model",
  
  
  
"items": [
  
  
  
  
"gpt-4o"
  
  
  
]
  
  
}
  
},
  
"created_at": "2026-05-30T08:30:00Z"
}

修改 API 密钥

POST
/api/v1/management/api-key/edit

覆盖式修改秘钥配置。建议先 get 拿到当前配置 → 在本地修改 → 完整 POST 回来。

限流:60 次/分钟

Request Body

application/json
JSON
{
  
"key": "sk-xxxxxxxxxxxx",
  
"alias": "生产环境-后端调用(已重命名)",
  
"security_config": {
  
  
"ip": {
  
  
  
"allow": [
  
  
  
  
"1.2.3.4"
  
  
  
]
  
  
},
  
  
"spend_limit": {
  
  
  
"monthly": 500
  
  
},
  
  
"geo": {
  
  
  
"countries": [
  
  
  
  
"CN"
  
  
  
]
  
  
},
  
  
"models": {
  
  
  
"mode": "model",
  
  
  
"items": [
  
  
  
  
"gpt-4o"
  
  
  
]
  
  
}
  
}
}

Responses

修改成功,返回最新视图

application/json
JSON
{
  
"alias": "生产环境-后端调用",
  
"enabled": true,
  
"security_config": {
  
  
"ip": {
  
  
  
"allow": [
  
  
  
  
"1.2.3.4"
  
  
  
]
  
  
},
  
  
"spend_limit": {
  
  
  
"monthly": 500
  
  
},
  
  
"geo": {
  
  
  
"countries": [
  
  
  
  
"CN"
  
  
  
]
  
  
},
  
  
"models": {
  
  
  
"mode": "model",
  
  
  
"items": [
  
  
  
  
"gpt-4o"
  
  
  
]
  
  
}
  
},
  
"created_at": "2026-05-30T08:30:00Z"
}

启用 / 禁用 API 密钥

POST
/api/v1/management/api-key/status

单字段动作,只变更 enabled 状态,不影响其他配置。

限流:60 次/分钟

Request Body

application/json
JSON
{
  
"key": "sk-xxxxxxxxxxxx",
  
"enabled": false
}

Responses

修改成功,返回确认后的 enabled 状态

application/json
JSON
{
  
"enabled": false
}

删除 API 密钥

POST
/api/v1/management/api-key/delete

支持批量删除,单次最多 1000 个。任一 key 未通过校验即整批拒绝

限流:60 次/分钟

Request Body

application/json
JSON
{
  
"keys": [
  
  
"sk-xxxxxxxxxxxx"
  
]
}

Responses

删除成功

application/json
JSON
{
  
"deleted": 1
}

查询账户余额

POST
/api/v1/management/account/balance

返回当前账户的余额。

限流:60 次/分钟

Responses

查询成功

application/json
JSON
{
  
"balance": "2203.81187842"
}

查询消费用量

POST
/api/v1/management/usage/summary

按日聚合的消费金额查询。

查询模式

  • 不传 key:账户级,账户下所有 API 密钥合并后的每日消费
  • key:单 key 级,过滤到指定 API 密钥的消费

限制

  • 日期格式 YYYY-MM-DD;闭区间,end >= start
  • 最长只支持查询近一年的数据,超过一年的历史数据不支持查询
  • 数据为离线数据,一般 T+1 更新,T 日查询可能不完整,请勿用于结算或对账
  • 响应不含 key——账户级与单 key 级返回结构一致,归属由调用方在请求侧自行掌握

限流:60 次/分钟

Request Body

application/json
JSON
{
  
"start": "2026-05-01",
  
"end": "2026-05-30"
}

Responses

查询成功

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"date": "2026-05-29",
  
  
  
"cost": "12.345600"
  
  
},
  
  
{
  
  
  
"date": "2026-05-30",
  
  
  
"cost": "8.910000"
  
  
}
  
],
  
"has_more": false,
  
"next_page": null
}

Powered by VitePress OpenAPI