Start run
start_runStart recording a video for a project (its newest main guide, or a specific guide_id), on the desktop or as a phone/tablet (device). Returns the run id; poll get_run until is_terminal. Credits are charged only when the video completes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| frame | No | Phones: portrait (9:16 in a phone frame, default), landscape (16:9 widescreen with the phone upright and centred, for YouTube) or none (the bare screen). Tablets: landscape or none. | |
| voice | No | Narrate this video with a specific voice id from list_voices; default is the project's voice. | |
| device | No | Record as a phone or tablet instead of the desktop: desktop, iphone, iphone-max, android, android-large, ipad, ipad-pro, android-tablet. One run is one device; for a desktop and a phone version start two runs with the same guide. Default is the project's device. | |
| backdrop | No | Behind the phone frame: neutral (grey, default) or brand (the organisation's brand kit colour). | |
| guide_id | No | A specific main guide id (from put_guide or list_projects); default is the newest. | |
| language | No | Narrate in this language (code from list_voices); default is the project's language. | |
| project_id | Yes | The project to record (from create_project or list_projects). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | Yes | What to do now. | |
| state | Yes | ||
| output | No | Device, frame and backdrop the video will use. | |
| run_id | Yes | Poll get_run with this id. | |
| narration | No | Language and voice the video will use. | |
| estimated_credits | No | Expected cost; charged only when the video completes. |