Poll task status | BeatAPI API Documentation

{
  "data": {
    "id": "task_8K2qA",
    "object": "task",
    "task_kind": "workflow",
    "capability_id": "music-video",
    "capability_version": 1,
    "status": "queued",
    "stage": "queued",
    "created_at": 1782210000,
    "updated_at": 1782210000,
    "completed_at": null,
    "output": null,
    "usage": {
      "credits_reserved": 1.5,
      "credits_charged": 1.5,
      "credits_settled": 0,
      "credits_refunded": 0,
      "billable_duration_seconds": 15
    },
    "request_id": "req_abc123",
    "error_code": null,
    "error_message": null,
    "workflow": "music-video",
    "storyboard": {
      "shots": []
    }
  }
}

Poll every 5-10 seconds. This endpoint allows up to 120 requests per minute per API key.

Authentication

AuthorizationBearer

Send your API key as Authorization: Bearer <BEATAPI_API_KEY>.

Path parameters

task_idstringRequired

Response

Task status

dataobject

Accepted or current BeatAPI task state.

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

$	curl https://api.beatapi.io/v1/tasks/task_8K2qA \
>	-H "Authorization: Bearer <token>"