Get account usage and concurrency

GET

/v1/usage

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200

application/json

Usage summary

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.beatapi.io/v1/usage' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "data": {
        "object": "usage",
        "credit_balance": 1080,
        "total_tasks": 12,
        "credits_settled": 720,
        "credits_refunded": 450,
        "concurrency": {
            "limit": 2,
            "active": 1
        },
        "by_workflow": [
            {
                "workflow": "music-video",
                "tasks": 8,
                "credits_settled": 480
            },
            {
                "workflow": "ecommerce-video",
                "tasks": 4,
                "credits_settled": 240
            }
        ]
    }
}

Modified at 2026-06-25 13:50:22

Poll task status

Upload a file for workflow inputs