Save guide
put_guideSave a guide on a project. With guide_id it is a new version of that guide; with a name no main guide on the project has yet it starts a new guide (one project can hold many videos); otherwise it is a new version of the newest guide. kind "auth" is the login flow (never recorded, may use {USERNAME}/{PASSWORD}); kind "main" is the walkthrough that becomes the video. Call get_guide_instructions before writing a guide and validate_guide before saving it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | auth = the login steps, run before recording and never shown; main = the walkthrough that becomes the video. | |
| name | No | Display name for a main guide, e.g. "Create your first campaign". A name the project has not used yet starts a new guide. | |
| content | Yes | The guide text, one step per line (get_guide_instructions has the syntax); up to 20000 characters. | |
| guide_id | No | Save as a new version of this guide (from list_projects or put_guide). | |
| project_id | Yes | The project (from create_project or list_projects). | |
| video_title | No | Title shown on the video's opening (main guides). Empty uses the guide name. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| name | Yes | ||
| lines | Yes | Non-empty lines saved. | |
| version | Yes | Versions count up per guide; earlier versions are kept. | |
| guide_id | Yes | Pass as guide_id to start_run to record exactly this version. | |
| project_id | Yes | ||
| video_title | No |