AI Recorder

Start a recording

Describe a flow and the agent records it. Long-running — poll the job. Billed per minute of finished video; failed and aborted jobs are free. On a site with a saved login, pass sessionId to pick one; omit it to use the site's default session.

Scope: recordings:write

Role permission: canCreate (OAuth only — API keys carry full workspace permissions)

post/v1/recordings

Request

  • Base URL: https://api.vidocu.ai
  • URL: https://api.vidocu.ai/v1/recordings
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://vidocu.ai/oauth/authorize, token URL https://api.vidocu.ai/oauth/token)

Request body

promptstring required

What the recording should show, up to 50,000 characters

urlstring uri
device'desktop' | 'mobile'
pacing'relaxed' | 'standard' | 'brisk'
maxDurationSecnumber

Max finished-video length in seconds; 0 or absent = no limit

removeLoadingboolean

Cut page-load waits (the first load, navigations, loads after a click) out of the video. Default false

mode'regular' | 'follow' | 'steps'
sessionIdstring

The saved login to start signed in with, by id from GET /v1/recorder-sessions. A site can have several (e.g. "Sandbox" and "Admin user"). Omit it to use the site's default session.

Response

Recording started

Changes

No recorded changes to this operation across all 1 revision of this API.