Your account
Usage & history
Two free endpoints for your own dashboards: a balance-and-totals summary for any date range, and the full paginated job history behind it.
The summary
GET/api/partner/v1/usage/summary
| Field | Type | Description |
|---|---|---|
| from | query, ISO datetime | Range start. Defaults to the first instant of the current UTC month. |
| to | query, ISO datetime | Range end. Defaults to now. |
Response
{
"credits_balance": 1131, // live, spendable now
"credits_balance_base": 2000, // balance at the last top-up
"credits_spent_lifetime": 869, // spent since that top-up
"credits_consumed_in_range": 561,
"job_counts": {
"completed": 12,
"failed": 1,
"running_or_queued": 0,
"total_in_range": 13
},
"from": "2026-07-01T00:00:00.000Z",
"to": "2026-07-08T09:00:00.000Z"
}About "lifetime"
credits_spent_lifetime counts spend since the last top-up (the base resets on each grant), not all-time. For all-time accounting, sum your job history below.
Job history
GET/api/partner/v1/usage/jobs
| Field | Type | Description |
|---|---|---|
| limit | query, int ≤100 | Default 30, newest first. |
| offset | query, int | Pagination offset. |
Response (one row)
{
"jobs": [
{
"workflow_id": "partner_scn_1783515143595_pnusyce",
"job_type": "multi_scene_video",
"status": "completed",
"credits_estimated": 620,
"credits_actual": 561,
"queued_at": "2026-07-08T04:12:23.595Z",
"completed_at": "2026-07-08T04:31:02.114Z",
"error_message": null,
"metadata": {
"phase": "completed",
"character_id": "…",
"video_url": "https://…/video.mp4",
"reserved_credits": 620
}
}
]
}Three things this list is for:
- Recovering a lost workflow_id — every job you ever queued is here.
- Progress labels —
metadata.phasewhile running, as covered in Jobs & polling. - Reconciliation —
credits_actualper job is the ground truth your invoices roll up from.
Try it
Try itGET/api/partner/v1/usage/summaryfree
Add your API key in the sidebar to enable this.
Try itGET/api/partner/v1/usage/jobsfree
Add your API key in the sidebar to enable this.