创建 API Key
POST /api/open/v1/keys请求体为 JSON,Content-Type: application/json。校验规则与控制台创建 Key 一致。
| 字段 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
name | string | 是 | — | 名称,最长 50 个字符(按字符计,不是字节);不能为空 |
remain_amount | number | 否 | 0 | 可用金额,站点币种,两位小数;unlimited 为 false 时生效,不能为负数且不能超过上限 |
unlimited | boolean | 否 | false | 是否无限额度 |
expired_time | integer | 否 | -1 | 过期时间,unix 秒;缺省、0、-1 均表示永不过期;其他值必须是未来时间且不超过 9999-12-31 |
model_limits_enabled | boolean | 否 | false | 是否启用模型白名单 |
model_limits | string | 否 | "" | 允许的模型,英文逗号分隔 |
allow_ips | string | 否 | — | 允许的 IP,换行分隔;不传或空字符串表示不限制 |
curl -X POST https://www.routeapi.ai/api/open/v1/keys \ -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "bot", "remain_amount": 5.00, "unlimited": false, "expired_time": -1, "model_limits_enabled": true, "model_limits": "gpt-4o" }'{ "success": true, "message": "", "data": { "id": 13, "name": "bot", "key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "status": 1, "created_time": 1729000000, "accessed_time": 1729000000, "expired_time": -1, "remain_amount": 5.00, "unlimited": false, "used_amount": 0.00, "model_limits_enabled": true, "model_limits": "gpt-4o", "allow_ips": "" }}字段说明见 Key 对象。
| HTTP | code | 场景 |
|---|---|---|
| 400 | invalid_request | 请求体不是合法 JSON,或为空 / null |
| 400 | invalid_request | name 缺失、为空白,或超过 50 个字符 |
| 400 | invalid_request | expired_time 不是未来时间(且不是 0 / -1),或超出 9999-12-31(例如误传毫秒时间戳) |
| 400 | invalid_request | 已达到每用户 Key 数量上限 |
| 400 | invalid_request | unlimited 为 false 时 remain_amount 为负数或超过上限 |
其他通用错误码见 开放平台 API 错误。
unlimited为true时忽略remain_amount。- 通过开放平台 API 创建 Key 会记录审计日志。