查询用户余额

查询当前用户的账户余额信息，包括可用余额、总余额、已消费金额等。

接口地址

GET /api/v1/balance

请求参数

该接口无需请求参数。

请求示例

cURL 示例

curl 'https://api.skyworkmodel.ai/api/v1/balance' \
  --header 'Authorization: Bearer <your-api-key>'

Python 示例

import requests

# 配置
base_url = "https://api.skyworkmodel.ai"
api_key = "Your-API-Key"

# 请求头
headers = {
    "Authorization": f"Bearer {api_key}",
}

# 发送请求
url = f"{base_url}/api/v1/balance"
response = requests.get(url, headers=headers)

# 处理响应
if response.status_code == 200:
    data = response.json()
    print(f"可用余额: {data['resp_data']['available_amount']} {data['resp_data']['currency']}")
    print(f"总余额: {data['resp_data']['total_amount']} {data['resp_data']['currency']}")
    print(f"已消费: {data['resp_data']['consumed_amount']} {data['resp_data']['currency']}")
else:
    print(f"请求失败: {response.status_code}")
    print(f"错误信息: {response.text}")

响应格式

成功响应

{
  "code": 200,
  "code_msg": "Success",
  "trace_id": "d37d2a9f2f1f61c7",
  "resp_data": {
    "user_id": 1234567890,
    "available_amount": 158.827506,
    "total_amount": 203.5,
    "consumed_amount": 44.672494,
    "currency": "USD"
  }
}

响应字段说明

字段名	类型	说明
code	integer	响应状态码，200 表示成功
code_msg	string	响应状态消息
trace_id	string	请求追踪 ID，用于问题排查
resp_data	object	响应数据对象
resp_data.user_id	integer	用户 ID
resp_data.available_amount	number	可用余额，单位由 currency 指定
resp_data.total_amount	number	总余额，单位由 currency 指定
resp_data.consumed_amount	number	已消费金额，单位由 currency 指定
resp_data.currency	string	货币单位，如 "USD"

错误响应

当请求失败时，返回错误信息：

{
  "code": 401,
  "code_msg": "Unauthorized",
  "trace_id": "xxx"
}

常见错误码：

错误码	说明
401	认证失败，API Key 无效或缺失
500	服务器内部错误

注意事项

1. 余额单位：余额金额的单位由 currency 字段指定，目前支持 USD 等货币单位
2. 精度：余额金额为浮点数，建议保留足够的小数位数进行计算
3. 频率限制：建议合理控制查询频率，避免频繁请求