Skip to content

Poll story generation status

GET
/v1/generate/story/{id}

Poll the status of an async story generation. Returns the current status, progress (scenes_completed / scenes_total), and the result when complete.

It returns the same data as GET /v1/jobs/{id}, which poll_url in the 202 response points to. Either endpoint can be polled.

id
required

Story job UUID.

string

Story job UUID.

OK

Media type application/json
object
completed_at

UTC timestamp when the job finished (completed or failed). Omitted if pending.

null | string format: date-time
created_at

UTC timestamp when the job was created.

string format: date-time
error

Error details. Present only when status is failed.

object
code

Machine-readable error code. Story jobs: model_refused (the model returned no image), upstream_error (the model rejected the request; retrying it unchanged fails), upstream_unavailable (the model was unavailable), generation_failed, post_generation_failed (an image was generated but could not be finished), service_unavailable (the story could not start in time), timeout (the story ran past the maximum time), internal_error, story_generation_failed. Single-image jobs: generation_failed, post_generation_failed, output_withheld (our check of the generated image withheld it; you were not charged), output_check_unavailable (the check of the generated image could not run; you were not charged). Any job: abandoned (it never finished), delivery_failed (generated and charged, but not delivered). message says what happened and what to do.

string
message

Human-readable description of why the job failed.

string
job_id

Unique async job identifier.

string format: uuid
result

Full generation result (same shape as synchronous create response, so cost_eur is in credits (EUR, excluding VAT)). Present only when status is completed.

scenes_completed

Number of scenes that have been generated so far.

integer
scenes_total

Total number of scenes requested.

integer
started_at

UTC timestamp when processing began. Omitted if not yet started.

null | string format: date-time
status

Job status: pending, processing, completed, or failed.

string

Bad Request

Media type application/json
object
details
error
string
message
string
request_id
string

Unauthorized

Media type application/json
object
details
error
string
message
string
request_id
string

Payment Required

Media type application/json
object
details
error
string
message
string
request_id
string

Forbidden

Media type application/json
object
details
error
string
message
string
request_id
string

Not Found

Media type application/json
object
details
error
string
message
string
request_id
string

Conflict

Media type application/json
object
details
error
string
message
string
request_id
string

Unprocessable Entity

Media type application/json
object
details
error
string
message
string
request_id
string

Too Many Requests

Media type application/json
object
details
error
string
message
string
request_id
string

Unavailable For Legal Reasons

Media type application/json
object
details
error
string
message
string
request_id
string

Internal Server Error

Media type application/json
object
details
error
string
message
string
request_id
string

Bad Gateway

Media type application/json
object
details
error
string
message
string
request_id
string

Service Unavailable

Media type application/json
object
details
error
string
message
string
request_id
string