Skip to main content
POST
Record a real website or product walkthrough, with a studio edit.

Authorizations

X-API-Key
string
header
required

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

Body

application/json
companyId
string
required
url
string
required

Full https URL to open first

steps
object[]
signedIn
boolean
default:false

Record in the user's browser profile

device
string
default:desktop

desktop or mobile

studio
boolean
default:true

Also render the studio edit

aspect
string
default:16:9

16:9, 9:16, 1:1 or 4:5

background
string

CSS background behind the window

title
string

Optional headline above the window

Response

200

Successful response