Skip to main content
GET
Get Scene
Pulls up everything about a single scene — the video details (duration, fps, resolution) plus where it is in processing. This is the endpoint you’ll poll after creating or importing a scene.
Check back every 5 seconds or so until status turns ready or failed.

Path parameters

Response

Example

Next steps

Once status is ready, use the scene’s id as scene_id in a render job.

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

scene_id
string
required

Response

Scene details

id
string
Example:

"660e8400-e29b-41d4-a716-446655440000"

name
string
Example:

"Dance Sequence"

status
enum<string>
Available options:
pending,
ready,
failed
duration_seconds
number | null
Example:

6.67

fps
number | null
Example:

30

total_frames
integer | null
Example:

200

width
integer | null
Example:

1920

height
integer | null
Example:

1080

job_id
string | null
Example:

"scene_660e8400e29b"

error_message
string | null
credits_used
number | null
Example:

6.67

created_at
string<date-time> | null
completed_at
string<date-time> | null