Get a generation

getGeneration

GET/v1/generations/{id}

Markdown fileTry in PlaygroundDocs version r8

Authentication

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

Path parameters

Path parameters
Field	Description
idstringRequired	Resource ID. Save it as soon as you receive it.

Responses

200 OK

Field Description

allowed_actionsstring[], can be nullRequired

Actions you can take now, such as cancel. Rely on this list instead of inferring from the status.

billing_closed_atdate-timeOptional

When the hold was settled or released; absent while Credits are still held.

billing_statusstringRequired

Pending awaits funding; unfunded closed without a hold; held means Credits are held for the task; settled charges verified delivery at the existing pricing rules; released returns the hold after failure, cancellation, timeout or zero-charge delivery; refunded reverses previously consumed generation Credits.

pendingunfundedheldsettledreleasedrefunded

closed_atdate-time, can be nullRequired

When the task closed. Stop polling once it is not null.

created_atdate-timeRequired

When the generation was accepted. Lists are ordered by this time, newest first.

customer_resolution_deadlinedate-timeRequired

Twenty-four hours after acceptance. Holds still unsettled at this time are released.

delivery_statusstringRequired

Output delivery: pending before upstream success; copying into managed storage; ready after verified delivery; failed when delivery cannot complete.

pendingcopyingreadyfailed

errorobject, can be nullRequired

Set when the task closed without a result. Read error.code.

Fields of error

Fields of error
codestringRequired	Funding: insufficient_balance, balance_negative (Credits were owed when the task came to be funded), budget_exceeded or spending_blocked; recovery_review when recovery closes an unfunded task for manual reconciliation. Provider: provider_unavailable after capacity/recovery exhaustion; input/output_moderated for safety refusal; input_media_invalid or input_media_unreachable for media refusal; draft_expired for an expired draft; input_rejected for unsupported input; delivery_failed when the provider succeeded but the output could not be stored; generation_failed for other terminal provider failures. Failed tasks release their customer hold. `insufficient_balancebalance_negativebudget_exceededspending_blockedrecovery_reviewprovider_unavailableinput_moderatedoutput_moderatedinput_media_invalidinput_media_unreachabledraft_expiredinput_rejecteddelivery_failedgeneration_failed`

execution_statusstringRequired

Supplier execution state, separate from delivery and billing: processing until execution ends. Succeeded means upstream execution finished, not that output delivery is ready.

processingsucceededfailedcanceledunresolved

held_atdate-timeOptional

When Credits were held for the task; absent while it awaits funding or when it closed unfunded.

idstringRequired

Resource ID. Save it as soon as you receive it.

inputanyOptional

The model input as accepted, after normalization, with media as sent: asset ids or your own URLs. Returned when reading a single task; list entries omit it.

key_idstringOptional

API key that created the task; empty for console tasks.

key_namestringOptional

late_result_availablebooleanRequired

A result that arrived after closing is provided at no charge.

metadatamap<string, string>Optional

Your own string values, returned unchanged. Put client_reference here so a lost response can be matched later.

modelstringRequired

Public model id the generation was created with.

priceobjectRequired

Credits for this task: estimated (the estimate, which is the amount held; the charge follows actual usage and may differ slightly), reserved (held right now), charged (actual usage at the fixed rate, 0.000 until settlement) and refunded (returned by a refund).

Fields of price

Fields of price
chargedstringRequired	Credits consumed by this task. Set when billing_status is settled: the actual usage the model reported at the fixed rate, which may be above or below estimated; any unused part of the hold returns to the balance, and usage above the hold is charged too. 0.000 in every other state, including after a refund.
estimatedstringRequired	The estimated cost of this task, in Credits, fixed when the task was accepted. This is the amount held for the task. The charge follows actual usage and may differ slightly from it, above or below.
refundedstringRequired	Credits a refund returned to the balance: what this task had been charged. 0.000 unless billing_status is refunded.
reservedstringRequired	Credits held for this task right now, as a decimal string with 3 places. Equal to estimated while billing_status is held, otherwise 0.000.
unitstringRequired	Every amount is in Credits. `credit`

queue_msintegerOptional

Milliseconds from acceptance to first dispatch.

resultobject, can be nullRequired

Delivered assets, once available.

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

run_msintegerOptional

Milliseconds from first dispatch to close.

sourcestringRequired

Where the generation was created: api (API key) or console (signed-in session).

apiconsole

started_atdate-timeOptional

When the task was first dispatched to run.

statusstringRequired

processing from acceptance until the task closes, including while it awaits funding and while outputs are copied; succeeded has delivered outputs; failed, canceled and unresolved are closed. Canceled is set by the system only, for example when a task is not funded or not started in time. Unresolved closes after the resolution deadline. A late result may still arrive without a new charge.

processingsucceededfailedcanceledunresolved

versionintegerRequired

Errors

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

Error body

Field Description

errorobjectRequired

Details of the error.

Fields of error

codestringRequired

Stable request error code. invalid_input rejects the request schema; invalid_credentials/scope_denied reject authentication/authorization; ip_not_allowed/model_not_allowed reject API key IP/model restrictions; resource_not_found hides missing or inaccessible resources; conflict rejects incompatible state; insufficient_balance/budget_exceeded/spending_blocked reject funding; balance_negative (402) refuses new tasks while the organization owes Credits from a charge above its hold, until a top-up repays them; rate_limited/concurrency_limited ask for a later retry; temporarily_unavailable is transient service capacity; request_failed covers other HTTP failures. tier_not_sold, draft_not_found, draft_expired and input_duration_out_of_range reject model-specific input. input_media_invalid rejects a detected format/type mismatch; input_media_too_large rejects a probed byte size above the model limit. storage_quota_exceeded rejects an upload when the organization's storage is full. See errors for field-level details.

invalid_inputinvalid_credentialsinsufficient_balancebalance_negativescope_deniedresource_not_foundconflictrate_limitedconcurrency_limitedtemporarily_unavailablerequest_failedip_not_allowedmodel_not_allowedtier_not_solddraft_not_founddraft_expiredinput_duration_out_of_rangeinput_media_invalidinput_media_too_largebudget_exceededspending_blockedstorage_quota_exceeded

errorsobject[], can be nullOptional

Fields of errors

Fields of errors
pathstringRequired
rulestringRequired

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
Status	What 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/$GENERATION_ID" \
  -H "Authorization: Bearer $VIZO_API_KEY"

Python

import os, requests

generation_id = "…"
res = requests.get(
    f"https://api.vizoapi.com/v1/generations/{generation_id}",
    headers={"Authorization": f"Bearer {os.environ['VIZO_API_KEY']}"},
    timeout=60,
)
print(res.status_code, res.json())

Node.js

const generation_id = "…";
const res = await fetch(`https://api.vizoapi.com/v1/generations/${generation_id}`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VIZO_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Response 200

{
  "allowed_actions": [],
  "billing_closed_at": "2026-11-02T08:00:00Z",
  "billing_status": "held",
  "closed_at": null,
  "created_at": "2026-11-02T08:01:43Z",
  "customer_resolution_deadline": "2026-11-03T08:00:12Z",
  "delivery_status": "pending",
  "error": null,
  "execution_status": "processing",
  "held_at": "2026-11-02T08:00:00Z",
  "id": "gen_01JD8Z5QW3XR",
  "input": {},
  "key_id": "string",
  "key_name": "string",
  "late_result_available": false,
  "metadata": {
    "client_reference": "order-1042"
  },
  "model": "MODEL_ID",
  "price": {
    "charged": "0.000",
    "estimated": "157.000",
    "refunded": "0.000",
    "reserved": "157.000",
    "unit": "credit"
  },
  "queue_ms": 1,
  "result": null,
  "run_ms": 1,
  "source": "api",
  "started_at": "2026-11-02T08:00:00Z",
  "status": "processing",
  "version": 1
}

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"
  }
}