Start a render
renderStart an asynchronous render by submitting a movie definition. Returns render ID and reserved credits for status polling.
Instructions
Submit a Movie definition (and optional webhook) and start an asynchronous render. Reserves credits and returns renderId, bucketName, and reservedCredits. Poll progress with get_status using the returned renderId and bucketName. All asset references must be URLs (vidhook does not generate assets). Insufficient credits return an error (HTTP 402). Authentication and watermarking are set by the VIDHOOK_API_KEY environment variable only (never a tool argument): vh_test_… renders a free/watermarked draft, vh_live_… renders clean/paid. The target environment is selected independently by VIDHOOK_API_BASE_URL (base URL), not by the key type.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| movie | Yes | Movie definition (json2video-compatible). resolution/scenes/elements etc. All asset references (video/image/audio src) must be URLs — vidhook does not generate assets; compose them on the agent side. Validated by the vidhook API. | |
| webhook | No | Optional completion-notification webhook (alongside the Movie fields). |