COST
扣费规则
每次请求按固定额度扣费，不随返回条数变化。
固定 1 点额度/次
实际扣费以响应头 x-api-cost 为准。
请求说明
参数
准备就绪
当前接口没有额外请求参数
响应说明
状态码与响应格式
200
当前鉴权会话信息。
响应头
x-api-remainx-api-cost
application/jsonobject
响应结构
{
"type": "object",
"required": [
"ok",
"data",
"error"
],
"properties": {
"ok": {
"type": "boolean",
"required": true
},
"data": {
"type": "object",
"required": true,
"shape": {
"type": "object",
"required": [
"user",
"apiKey",
"quota"
],
"properties": {
"user": {
"type": "object",
"required": true,
"shape": {
"type": "object",
"required": [
"userId"
],
"properties": {
"userId": {
"type": "string",
"required": true
}
}
}
},
"apiKey": {
"type": "object",
"required": true,
"shape": {
"type": "object",
"required": [
"revokeId",
"issuer",
"maskedApiKey",
"activeFrom",
"expiresAt",
"dailyTokenLimit",
"scopes"
],
"properties": {
"revokeId": {
"type": "string",
"required": true
},
"issuer": {
"type": "webapp | api",
"required": true,
"enum": [
"webapp",
"api"
]
},
"maskedApiKey": {
"type": "string",
"required": true
},
"activeFrom": {
"type": "integer",
"required": true
},
"expiresAt": {
"type": "integer",
"required": true
},
"dailyTokenLimit": {
"type": "integer",
"required": true
},
"scopes": {
"type": "array<string>",
"required": true,
"shape": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"quota": {
"type": "object",
"required": true,
"shape": {
"type": "object",
"required": [
"tokenLimit",
"remain",
"refillAmount",
"refillIntervalSeconds",
"nextRefillAt"
],
"properties": {
"tokenLimit": {
"type": "integer",
"required": true
},
"remain": {
"type": "integer",
"required": true
},
"refillAmount": {
"type": "integer",
"required": true
},
"refillIntervalSeconds": {
"type": "integer",
"required": true
},
"nextRefillAt": {
"type": "integer | null",
"required": true
}
}
}
}
}
}
},
"error": {
"type": "string",
"required": true
}
}
}示例响应
{
"ok": true,
"data": {
"user": {
"userId": "example-user"
},
"apiKey": {
"revokeId": "6cbf6ef0-27c7-43ee-9833-demo",
"issuer": "api",
"maskedApiKey": "ocrh_api_abcd1234************************",
"activeFrom": 1741968000,
"expiresAt": 1744560000,
"dailyTokenLimit": 1000,
"scopes": [
"api.auth.me.read",
"api.records.daily.read"
]
},
"quota": {
"tokenLimit": 1000,
"remain": 998,
"refillAmount": 5,
"refillIntervalSeconds": 300,
"nextRefillAt": 1744560300
}
},
"error": ""
}401
请求未携带有效的认证信息，或提供的 API Key 已失效。
响应头
x-api-remainx-api-cost
application/jsonobject
响应结构
{
"type": "object",
"required": [
"ok",
"data",
"error"
],
"properties": {
"ok": {
"type": "boolean",
"required": true
},
"data": {
"type": "string",
"required": true
},
"error": {
"type": "string",
"required": true
}
}
}示例响应
{
"ok": false,
"data": "API Key 无效或已过期。",
"error": "invalid_api_key"
}