Validate guide
validate_guideCheck a guide before saving it: unknown [DIRECTIVES], undefined {VARIABLES}, secrets typed literally, steps that cannot execute, missing "Go to" start, length versus the 5-minute cap. Returns problems with line numbers, an estimated video length and an estimated credit cost. Costs nothing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | auth = login steps; main = the walkthrough that becomes the video. | |
| device | No | Check for a phone or tablet run (a preset such as iphone or ipad): warns about hover steps and large zooms. Default: the project's device. | |
| content | Yes | The guide text to check, one step per line. | |
| project_id | No | When given, {VARIABLES} are checked against the project and a credit estimate is returned. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| passed | Yes | true when there are no problems; warnings alone do not fail a guide. | |
| problems | Yes | Must be fixed before put_guide. | |
| warnings | Yes | Worth fixing; the guide still records. | |
| action_steps | Yes | Steps the browser performs (directive-only lines excluded). | |
| estimated_length | Yes | Rough video length, e.g. "2:10". | |
| estimated_credits | No | Present for main guides when project_id is given. |