Skip to main content
GET
Get Balance

Get Balance

Retrieve your current credit balance, including available credits and credits frozen by in-progress tasks.

Request

Headers

x-api-key
string
required
Your API key.

Response

code
number
HTTP status code (200 on success).
data
object
available
number
Credits available to spend on new tasks.
frozen
number
Credits reserved by tasks that are currently in progress.
total
number
Total credits (available + frozen).

Example response

200

Code examples

Errors