Skip to main content
GET
Get generation job status

Authorizations

Authorization
string
header
required

An app API key, e.g. Authorization: Bearer sk_live_…. Secret (sk_) for writes/sessions; publishable (pk_) is read-only (browser-safe).

Path Parameters

jobId
string<uuid>
required

Response

Job status

A durable async generation job (returned by async create + GET /v1/jobs/{jobId}). A multi-chapter campaign job (kind: from_book, created by POST /v1/campaigns) reports its per-chapter progress through the actsDone/actsTotal counters below and carries the parent campaignId.

jobId
string<uuid>
status
enum<string>
Available options:
queued,
running,
succeeded,
failed,
cancelled
phase
string | null

Not driven for a campaign (from_book) job; use actsDone/actsTotal to render its progress.

progress
number

0–1 for a single-world job. NOT driven for a campaign (from_book) job, it stays at its queued default; use actsDone/actsTotal for a campaign's progress bar instead.

worldId
string<uuid> | null

For a single-world job, the created world (set on success). For a campaign (from_book) job, the FIRST authored chapter's world id, read the full ordered chapter list from GET /v1/campaigns/{id}.

campaignId
string<uuid> | null

The parent campaign. Populated for a multi-chapter (from_book) job; null on a single-world job.

actsDone
integer | null

Chapters authored so far, advances as each chapter is authored and saved. Populated for a from_book campaign job; null on a single-world job.

actsTotal
integer | null

Total chapters the campaign will author (the story spine's act count, known after the spine stage). Populated for a from_book campaign job; null on a single-world job.

error
string | null
schemaVersion
string
Example:

"1.0"