Skip to content
Docs version r15
OpenAPIJSONYAML
API reference / Generations

listGenerations

GET/v1/generations

Markdown fileTry in PlaygroundDocs version r15

Authentication

Send your project key in the request header, for example Authorization: Bearer $VIZO_API_KEY. Keep the key on your server.

Query parameters

Query parameters
FieldDescription
limitintegerOptional

Page size.

Minimum 1, Maximum 100, Default 50
client_referencestringOptional

Your own reference for this request.

At most 256 characters
cursorstringOptional

Cursor from the previous page.

At most 64 characters

Responses

200 OK

200 OK
FieldDescription
entriesobject[], can be nullRequired
Fields of entries
Fields of entries
allowed_actionsstring[], can be nullRequired
billing_statusstringRequired
closed_atdate-time, can be nullRequired
customer_resolution_deadlinedate-timeRequired
delivery_statusstringRequired
errorobject, can be nullRequired
Fields of error
Fields of error
codestringRequired

Why the task closed without a result, for example insufficient_balance, budget_exceeded or spending_blocked.

execution_statusstringRequired
idstringRequired
late_result_availablebooleanRequired
metadatamap<string, string>Optional
priceobjectRequired
Fields of price
Fields of price
chargedstringRequired
price_versionstringRequired
quotedstringRequired
reservedstringRequired
unitstringRequired
credit
resultobject, can be nullRequired
Fields of result
Fields of result
asset_idstringOptional
last_frame_asset_idstringOptional
metadataobjectOptional
Fields of metadata
Fields of metadata
durationintegerOptional
framesintegerOptional
framespersecondintegerOptional
generate_audiobooleanOptional
ratiostringOptional
resolutionstringOptional
seedintegerOptional
outputsobject[], can be nullOptional
Fields of outputs
Fields of outputs
asset_idstringRequired
content_typestringRequired
indexintegerRequired
voice_idstringOptional
statusstringRequired
versionintegerRequired
next_cursorstringOptional

Pass as cursor to read the next page. Empty on the last page.

Errors

Errors share one body. Include the request_id when you contact support.

Error body

Error body
FieldDescription
errorobjectRequired

Details of the error.

Fields of error
Fields of error
codestringRequired

Stable error code to branch on.

messagestringRequired

Readable explanation. Do not parse it.

request_idstringRequired

Include this when you contact support.

retryablebooleanRequired

True for 429 and 503 only. Even then, check recent tasks before you send a create request again.

task_idstringOptional

The task this error belongs to, when one exists.

Errors
StatusWhat it means and what to do
401

The key is missing, malformed, expired or revoked. Correct the key on your server, then continue.

402

Available Credits cannot cover this request. Add Credits, wait for them to be credited, then check the balance.

403

The key scope, email verification, a budget or an account restriction blocks this. Check the key type, scopes and project budget.

404

The model or resource does not exist or is outside this project. Check the project, the ID and that the model is enabled.

409

The request conflicts with the current state. Read the resource again and decide whether to send the request again.

422

A field or value is invalid. Compare the request with the field table and the model page.

429

Too many requests. No task was created. Wait for the Retry-After time before sending again.

500

The server failed and the task may already be accepted. Do not resend; list recent tasks first.

503

The service is temporarily unavailable. For a create request, list recent tasks and confirm none was accepted before you submit again.

Request example

cURL
curl "https://api.vizoapi.com/v1/generations?limit=20" \
  -H "Authorization: Bearer $VIZO_API_KEY"
Python
import os, requests

res = requests.get(
    "https://api.vizoapi.com/v1/generations?limit=20",
    headers={"Authorization": f"Bearer {os.environ['VIZO_API_KEY']}"},
    timeout=60,
)
print(res.status_code, res.json())
Node.js
const res = await fetch("https://api.vizoapi.com/v1/generations?limit=20", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VIZO_API_KEY}`,
  },
});
console.log(res.status, await res.json());
Response 200
{
  "entries": [
    {
      "allowed_actions": [
        "cancel"
      ],
      "billing_status": "held",
      "closed_at": null,
      "customer_resolution_deadline": "2026-11-03T08:00:12Z",
      "delivery_status": "pending",
      "error": null,
      "execution_status": "queued",
      "id": "gen_01JD8Z5QW3XR",
      "late_result_available": false,
      "metadata": {
        "client_reference": "order-1042"
      },
      "price": {
        "charged": "0.000",
        "price_version": "p3",
        "quoted": "1400.000",
        "reserved": "1400.000",
        "unit": "credit"
      },
      "result": null,
      "status": "queued",
      "version": 1
    }
  ],
  "next_cursor": ""
}
Response 401
{
  "error": {
    "code": "invalid_credentials",
    "message": "API key is missing, malformed, expired or revoked.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 402
{
  "error": {
    "code": "insufficient_balance",
    "message": "Available credits cannot cover the hold.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 403
{
  "error": {
    "code": "scope_denied",
    "message": "The key does not allow this operation for this project.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 404
{
  "error": {
    "code": "resource_not_found",
    "message": "The resource is not available to this project.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 409
{
  "error": {
    "code": "conflict",
    "message": "The request conflicts with the current state of the resource.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 422
{
  "error": {
    "code": "invalid_input",
    "message": "Input does not match the published schema.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 429
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Check Retry-After.",
    "retryable": true,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 500
{
  "error": {
    "code": "request_failed",
    "message": "The request failed. Check recent generations before submitting again.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
Response 503
{
  "error": {
    "code": "temporarily_unavailable",
    "message": "Service is temporarily unavailable.",
    "retryable": true,
    "request_id": "9f2c41d07ab3e5c8"
  }
}