List animation tasks
Source-generated GET /animations reference: authentication, fields, responses, errors, and operational safeguards.
On this page
Operation
GET /animations
operationId: list_one_click_animations_v1_animations_get
List tasks owned by the authenticated account. Pass next_cursor unchanged to retrieve the next page; null ends pagination. Limits and rate budgets are account-wide, not per key.
Authentication and side effects
Use a server-side Bearer API key. Required scope: animations:read
This operation does not start paid generation. Other state changes are described above.
Parameters
| Parameter | Location | Type | Required | Constraints / default | Meaning |
|---|---|---|---|---|---|
limit |
query |
integer |
No | minimum: 1; maximum: 100; default: 20 |
Maximum records in this page, not an account concurrency limit. |
cursor |
query |
string / null |
No | — | Opaque next_cursor from the prior page; pass unchanged. |
Responses
| HTTP | Body | Meaning |
|---|---|---|
200 |
TaskListResponse | Successful public response. Example values are illustrative. |
400 |
APIErrorEnvelope | Invalid input; correct the request before retrying. |
401 |
APIErrorEnvelope | Missing, expired, or revoked API key. |
403 |
APIErrorEnvelope | Account eligibility, account status, or key scope does not allow this operation. |
404 |
APIErrorEnvelope | Resource is unavailable, not owned, or its signature is invalid/expired. |
429 |
APIErrorEnvelope | Account-wide rate or queue limit; wait for Retry-After. |
500 |
APIErrorEnvelope | Internal failure; preserve the task/key and retry only when marked retryable. |
503 |
APIErrorEnvelope | Service/provider unavailable; retry only when error.retryable is true. |
Response headers
| HTTP | Header | Type | Meaning |
|---|---|---|---|
429 |
Retry-After |
integer |
Suggested wait in seconds; respect the server value and an overall deadline. |
503 |
Retry-After |
integer |
Suggested wait in seconds; respect the server value and an overall deadline. |
Response example
{
"data": [
{
"created_at": "2026-08-30T00:00:00Z",
"credits": {
"charged": 0,
"held": 1,
"quoted": 1
},
"error": null,
"finished_at": null,
"id": "00000000-0000-4000-8000-000000000002",
"metadata": {},
"normalized_input": {},
"object": "animation",
"outputs": [],
"progress": 0,
"stage": "queued",
"started_at": null,
"status": "queued"
}
],
"next_cursor": null,
"object": "list"
}
Related guides
Was this page helpful?
No search queries, code, or free text are collected. This switch controls documentation interactions only; general site analytics follow the privacy policy. Privacy policy