Skip to main content
GET
Poll a scene-writer job started by POST .../scenes.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

canvasId
string
required
jobId
string
required

Response

The scene writers' job: writing, completed (with the result) or failed (with the error)

Scenes written from briefs

written
string[]

Scene ids written

failed
object

Scene id -> why it was not written

problems
object

Scene id -> problems still open on its check frame

other
string[]

Problems not tied to one scene

imageUrl
string

Contact sheet with one check frame per written scene

seconds
integer

Time the writers took

status
string

writing, completed or failed

jobId
string

Job to poll at GET .../scenes/jobs/ while status is writing

error
string

Why a failed job failed