1. Usage & Limits
BeatAPI
  • Quick Start
  • BeatAPI Realtime Video API
  • Music Video API
    • Create Video
      • Create Music Video
    • Advanced Editing
      • Edit Shot
      • Get Shot Media
      • Compose Video
  • Ecommerce Video API
    • Create Ecommerce Video
  • Reference
    • API Overview
      • List launch workflows
    • Task Status
      • Poll task status
    • Usage & Limits
      • Get account usage and concurrency
        GET
    • Upload Files
      • Upload a file for workflow inputs
    • Webhooks
      • List webhook endpoints
      • Create a webhook endpoint
      • Get a webhook endpoint
      • Update a webhook endpoint
      • Delete a webhook endpoint
  • Realtime Video API
    • Create a realtime browser session
    • Get a realtime session
    • Close a realtime session
  1. Usage & Limits

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 ********************
or

Responses

🟢200
application/json
Usage summary
Bodyapplication/json

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.beatapi.io/v1/usage' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - 成功示例
{
    "data": {
        "object": "usage",
        "credit_balance": 1080,
        "total_tasks": 12,
        "credits_settled": 720,
        "credits_refunded": 450,
        "concurrency": {
            "limit": 2,
            "active": 1
        },
        "realtime": {
            "sessions": 3,
            "credits": 90,
            "active": 1
        },
        "by_workflow": [
            {
                "workflow": "music-video",
                "tasks": 8,
                "credits_settled": 480
            },
            {
                "workflow": "ecommerce-video",
                "tasks": 4,
                "credits_settled": 240
            }
        ]
    }
}
Modified at 2026-07-31 15:10:04
Previous
Poll task status
Next
Upload a file for workflow inputs
Built with