Record screen
record_screenCreate a screen-recording clip in a project. Creates blank placeholder clips, registers job entities, and sends the job to AVS.
The blank clips this tool creates are placeholders; they become video clips when processing completes, so removing one loses that scene. Article placeholders are also inserted automatically into plainDoc.
Requires the Auto-Recording add-on and per-workspace sign-in credentials for the product being recorded. Workspaces without it get back the manual path instead (upload_file, then add_clips(kind='video')) rather than a failure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scenes | Yes | REQUIRED — the recording to make, as a list of scenes. This is the ONLY way to specify what to record. A normal single recording is exactly ONE scene; a code-wizard multi-scene / marketing video is N scenes (one clip per scene, and ALL cuts of one video go in a SINGLE record_screen call). A narrated scene REQUIRES a non-empty narration_script; a b-roll scene is silent (no narration, no article). A cut that starts somewhere disconnected is just a scene with entry.mode "fresh". Cleopatra orgs accept exactly ONE narrated scene. Do not set scene_id — it is assigned server-side. | |
| chat_id | Yes | Conversation context ID | |
| guide_id | Yes | Target guide ID | |
| language | No | Language code for the recording (default: en) | en |
| edit_scene_ids | No | The clip id(s) this edit replaces. Only used when recording_session_id is set; scenes you do not name are not re-filmed. Set preceding_clip_id to the clip you are replacing — an edit naming a clip that is not in the guide is refused rather than appended to the end. | |
| video_intention | No | One-line intent shared across all scenes of a multi-scene recording (e.g. "punchy 30s launch teaser for feature X"). Ignored for single-scene recordings. | |
| preceding_clip_id | Yes | Clip ID after which to insert the new clip | |
| exact_video_script | No | Set to true when the video narration must be used exactly as written — the agent that does the recording will not reword, rephrase, or rewrite video_script at all. Default false. | |
| custom_instructions | No | Optional per-recording instructions (e.g. "select project X", "add rectangle 200x100"). Not related to mocking. | |
| exact_article_script | No | Set to true when the article must be used exactly as written — the agent that does the recording will not reword, rephrase, or rewrite article_script at all. Default false. | |
| recording_session_id | No | EDIT an existing recording instead of shooting a new one. Pass the recording_session_id from the record_screen that made it, or read it off get_clip. The recorder restores that take's code, notes and click script and changes only what you ask for, which is far faster and cheaper than re-recording. Omit for a fresh recording. Only code-wizard recordings are editable; get_clip omits the field for any clip that is not. |