API Reference
Create API Key
Create新的 API Key，并只返回一次明文 Token。
POST
/api/open/v1/keysEndpoint Overview
201api_keys:write
Create新的 API Key，并只返回一次明文 Token。
Authentication
Use this request header:
Authorization: Bearer <token>Required scopes for this endpoint:
api_keys:writeRequest Body
name
stringRequiredAPI Key 名称。
environment
enum<string>Default: testCreate到哪个环境，默认 test。
testlive
scopes
scope[]要授予该 Key 的 scopes；不传时默认只给读取类 scopes。
Response
201 - application/json
object
string固定为 open_api.key.create。
key
object新建后的 Key 信息。
id
stringAPI Key ID。
name
stringAPI Key 名称。
environment
enum<string>所属环境。
testlive
scopes
scope[]当前 Key 具备的 scopes。
status
enum<string>Key 状态。
activerevoked
tokenPrefix
stringToken 前缀。
tokenLast4
stringToken 后四位。
maskedToken
string掩码后的 Token 展示值。
createdAt
stringCreation time.
updatedAt
stringUpdated time.
lastUsedAt
string | null最近使用时间。
lastUsedIp
string | null最近使用 IP。
lastUsedUserAgent
string | null最近使用的 User-Agent。
revokedAt
string | null撤销时间。
token
string新签发的明文 Token，只会返回一次。
Common Errors
UNAUTHORIZED
error_codeMissing or invalid Bearer token.
RATE_LIMITED
error_codeThe current token hit a rate limit.
NOT_FOUND
error_code当前 API Key 不存在，或已被清理。
Notes
- Create成功后请立即持久化 token。后续只能看到 maskedToken，无法再次读取明文。
Was this page helpful?