Usage

Retrieve account balances, subscription credits, and more.... with an account key.

We furnish you with four informational fields:

1. balance: Your balance

2. stats: Statistics of all tasks by status

3. subscriptionStats: Keep track of your plan's status to determine whether to proceed with additional tasks or wait.

4. dailyLimit: This information field assists you in verifying if you have surpassed your daily credit usage limit

Balance

View Your Balance

Stats

Statistics of all tasks by status

// Example
[
    {
      "_count": 0,
      "status": "PENDING"
    },
    {
      "_count": 0,
      "status": "PROCESSING"
    },
    {
      "_count": 0,
      "status": "SUCCESS"
    },
    {
      "_count": 0,
      "status": "FAILED"
    }
  ]

SubscriptionStats

Keep track of your plan's status to determine whether to proceed with additional tasks or wait.

The waiting tasks cannot surpass twice the number of concurrent processes.

// Example
[
    {
      "available": 5,
      "pending": 0,
      "planId": "2b2abf3d54f14416943aa294a9fd025f"
    }
  ]

DailyLimit

This information field assists you in verifying if you have surpassed your daily credit usage limit

If the daily limit displays as 0, it indicates there are no restrictions.

// Example
{
    "endOfDay": 1700783999999,
    "dailyLimit": 0,
    "dailyConsumption": 0,
    "isAvailable": true
  }

Please don't call this method more than once every 30 seconds, and use a memory/disk cached value instead.

GET/tasks/usage

Query parameters

Response

200

Body

application/json

balance*number

Your balance

stats*array of GetTaskStatsResponseDto (object)

subscriptionStats*array of getSubscriptionStatsResponseDto (object)

dailyLimit*DailyLimitResponseDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/tasks/usage', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "balance": 0,
  "stats": [
    {
      "_count": 0,
      "status": "PROCESSING"
    }
  ],
  "subscriptionStats": [
    {
      "available": 0,
      "pending": 0,
      "planId": "2b2abf3d54f14416943aa294a9fd025f"
    }
  ],
  "dailyLimit": {
    "dailyLimit": 0,
    "dailyConsumption": 10,
    "endOfDay": 1716355262213,
    "isAvailable": false
  }
}