generate_video
Generate a short video from a text prompt and save it to disk.
Instructions
Generate a short video from a text prompt and save it to disk. Asynchronous: the provider renders in the background and this call waits, typically one to three minutes. Call it only when the user explicitly asks for a video — reference images and videos are not supported. Returns the absolute path of the saved file, the task id and how long it waited.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| model | No | Video model id for this call only. Omit to use the configured default. Call get_config for the available ids and their notes. | |
| ratio | No | Aspect ratio as W:H, for example 16:9 or 9:16. Default 16:9. | |
| prompt | Yes | What to film, in natural language. Describe the subject, the action and the camera movement: a shot the model can stage beats a list of keywords. | |
| duration | No | Clip length in seconds. Default 5. Longer clips take longer and cost more; the provider decides which lengths it accepts. | |
| outputDir | No | Directory for this call only. Omit to use the configured default, which is <workspace>/video_output. | |
| timeoutMs | No | How long the whole call may wait — create, poll, download — in milliseconds. Omit to use the configured default. A five second clip measured about four minutes, so keep this generous; the ceiling is 3600000 (one hour). |