Query User Balance

Query the current user's account balance information, including available balance, total balance, consumed amount, etc.

Endpoint

GET /api/v1/balance

Request Parameters

This endpoint does not require any request parameters.

Request Examples

cURL Example

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

Python Example

import requests

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

# Request headers
headers = {
    "Authorization": f"Bearer {api_key}",
}

# Send request
url = f"{base_url}/api/v1/balance"
response = requests.get(url, headers=headers)

# Handle response
if response.status_code == 200:
    data = response.json()
    print(f"Available balance: {data['resp_data']['available_amount']} {data['resp_data']['currency']}")
    print(f"Total balance: {data['resp_data']['total_amount']} {data['resp_data']['currency']}")
    print(f"Consumed: {data['resp_data']['consumed_amount']} {data['resp_data']['currency']}")
else:
    print(f"Request failed: {response.status_code}")
    print(f"Error message: {response.text}")

Response Format

Success Response

{
  "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"
  }
}

Response Field Description

Field Name	Type	Description
code	integer	Response status code, 200 indicates success
code_msg	string	Response status message
trace_id	string	Request trace ID for troubleshooting
resp_data	object	Response data object
resp_data.user_id	integer	User ID
resp_data.available_amount	number	Available balance, unit specified by currency
resp_data.total_amount	number	Total balance, unit specified by currency
resp_data.consumed_amount	number	Consumed amount, unit specified by currency
resp_data.currency	string	Currency unit, such as "USD"

Error Response

When the request fails, an error message is returned:

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

Common error codes:

Error Code	Description
401	Authentication failed, invalid or missing API Key
500	Internal server error

Notes

1. Balance Unit: The unit of balance amount is specified by the currency field, currently supporting currency units such as USD
2. Precision: Balance amounts are floating-point numbers, it is recommended to retain sufficient decimal places for calculations
3. Rate Limiting: It is recommended to control query frequency reasonably to avoid frequent requests