Skip to main content
POST
Create and start a demo

Authorizations

Authorization
string
header
required

An API key from the Developers page.

Body

application/json
url
string<uri>
required
Maximum string length: 2048
task
string
required
Required string length: 5 - 8000
check_id
string
answers
object[]
site_login
object

Login for the site being recorded. Encrypted on arrival; never logged or returned.

options
object
callback_url
string<uri>

HTTPS URL that gets this demo's webhook events.

metadata
object

Your own values, returned on the demo and in webhook payloads.

idempotency_key
string

Sending the same key again returns the same demo (200).

Maximum string length: 100

Response

An earlier demo with the same idempotency_key

id
string<uuid>
required
object
string
required
Allowed value: "demo"
status
enum<string>
required
Available options:
canceled,
completed,
failed,
in_progress,
input_required,
queued
stage
enum<string> | null
Available options:
analyzing,
editing,
narrating,
recording,
rendering,
null
progress
object
queue
object | null
title
string | null
url
string<uri>
task
string
language
string | null
input_request
object | null

A question the recorder is waiting on.

video
object | null
failure
object | null
app_url
string<uri>
source
enum<string>
Available options:
api,
mcp,
web
metadata
object
check_again_in_seconds
integer

Wait at least this long before polling again. 0 when finished.

created_at
string<date-time>
updated_at
string<date-time>
finished_at
string<date-time> | null