Generate a video
generate_videoStart a text-to-video generation job from a prompt, returning a background job to poll. Costs credits per second based on model and quality.
Instructions
Start a text-to-video generation. COSTS CREDITS — priced per second, from about 5 to 53 credits a second depending on model and tier, so a 5-second clip ranges from ~25 to ~265 credits. Charged when the job is accepted, not when it succeeds. Get valid model, quality, duration and aspect values from list_studio_models, and check the balance with whoami first. Returns a job that renders in the background; poll it with get_video_job.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| audio | No | Whether to generate sound. Only has an effect on models whose `audio.switchable` is true, and audio usually costs more per second. | |
| model | Yes | Model id from list_studio_models (video.models[].id). | |
| aspect | No | Aspect ratio from the model's `aspects`. Defaults to auto. | |
| prompt | Yes | What should happen in the shot. | |
| quality | Yes | Quality/tier id from that model's `qualities`. The main cost lever. | |
| duration | Yes | Seconds, as a string, from the model's `durations` — e.g. '5'. Multiplies cost. | |
| useBrand | No | Fold the workspace's brand context into the prompt. Defaults to true; set false for a shot that has nothing to do with the brand. | |
| workspaceId | No | Workspace to act in. Defaults to the active one. |