Record a UI walkthrough (screen recording)
vivid_record_uiRecords scripted browser interactions as a screen-capture video with visible cursor, then uploads the result to VIVID as a video asset for editor projects and timelines.
Instructions
Record a screen-capture video of vividai.tv (or any site) by driving a local Chromium with Playwright: a scripted list of steps (navigate, move, click, type, scroll, wait) is executed with a visible cursor, smooth mouse moves and click ripples, and the result is uploaded to VIVID as a video asset ready for vivid_create_editor_project / vivid_edit_timeline (pass the returned durationMs as media[].durationMs). On VIVID sites the browser is logged into the account of VIVID_API_KEY automatically (login=true), so app pages open directly; other sites never receive the session. Runs on THIS machine: needs Google Chrome (or npx playwright install chromium) and, for mp4 output, ffmpeg (otherwise webm, which the editor handles). Default site: https://vividai.tv. Tips: onboarding on /create can be skipped with click "[data-testid=onboarding-skip]"; keep clips short (one feature per recording) and slow the pace with waitMs. Costs no credits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Start URL or site path (default "/dashboard"). | |
| name | No | Asset file name (without extension). | |
| site | No | Site origin to record and log into (default vividai.tv; use https://stage.vividai.tv for staging). | |
| login | No | Seed the browser with a session of the API-key account before opening the site (VIVID sites only; ignored elsewhere). | |
| scale | No | Device scale factor: 2 records 1440×900 as a crisp 2880×1800. | |
| steps | Yes | ||
| cursor | No | Draw a cursor with click ripples. | |
| format | No | auto = mp4 when ffmpeg is installed, else webm. | auto |
| locale | No | it-IT | |
| tailMs | No | Still time before stopping. | |
| upload | No | Upload to VIVID as a permanent video asset. | |
| headless | No | false shows the browser window while recording. | |
| leadInMs | No | Still time after the first page loads. | |
| viewport | No | CSS viewport (default 1440×900). Use 390×844 for a phone. | |
| outputPath | No | Also save the video to this absolute local path. | |
| colorScheme | No | dark | |
| hideSelectors | No | CSS selectors hidden for the whole recording (banners, chat widgets). | |
| stepTimeoutMs | No |