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.

GET /v1/jobs/{id} returns the same data for story jobs. This endpoint exists so the poll URL in the 202 response is self-documenting.

id
required

Story job UUID.

string

Story job UUID.

OK

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 (e.g. content_rejected, insufficient_credits).

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). 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

object
details
error
string
message
string
request_id
string

Unauthorized

object
details
error
string
message
string
request_id
string

Payment Required

object
details
error
string
message
string
request_id
string

Forbidden

object
details
error
string
message
string
request_id
string

Not Found

object
details
error
string
message
string
request_id
string

Conflict

object
details
error
string
message
string
request_id
string

Unprocessable Entity

object
details
error
string
message
string
request_id
string

Too Many Requests

object
details
error
string
message
string
request_id
string

Unavailable For Legal Reasons

object
details
error
string
message
string
request_id
string

Internal Server Error

object
details
error
string
message
string
request_id
string

Bad Gateway

object
details
error
string
message
string
request_id
string

Service Unavailable

object
details
error
string
message
string
request_id
string