Add or update an overlay
put_video_overlayAdd or update one timed text, image or video overlay with none, fade, slide or pop animation. Use only existing canvas asset IDs and editable capabilities returned by the project. Read get_project_context first and pass its base_version and selected output_id. Saves a playable project; request a file separately with check_video with_download. Unsupported changes refuse without rebuilding. Preserve operation_id and exact inputs on retries. Uses the account's direct-edit allowance. Cost: Free: no credits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| overlay | Yes | ||
| video_id | Yes | The video id from list_videos. | |
| output_id | No | One output (a hook, a Short, a format) from check_video; the main film when left out. | |
| base_version | No | The version the edits are for; the current one when left out. | |
| operation_id | No | A stable ID for this request. Preserve it on retries. Use a new ID only for a deliberate new request. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | ||
| cost | No | ||
| error | No | ||
| state | No | ||
| status | No | ||
| dry_run | No | ||
| message | No | ||
| plan_id | No | ||
| style_id | No | ||
| video_id | No | ||
| available | No | ||
| import_id | No | ||
| output_id | No | ||
| studio_url | No | ||
| version_id | No |