Compose a scene clip
compose_sceneGenerates one short video clip from a written brief, optionally using up to 4 of your saved characters as references and one of your saved or uploaded images as the opening frame. Spends credits. Returns a task id; check it with get_task. For full control over a single shot, use generate_video instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| brief | Yes | What the scene shows, its beats and mood. | |
| style_tags | No | Optional style words added to the brief, for example "cinematic", "golden hour", "handheld". | |
| aspect_ratio | No | Aspect ratio of the clip. | 9:16 |
| atmosphere_id | No | Optional id of one of your saved images (for example a background) to use as the opening frame. Find ids with list_characters. | |
| character_ids | No | Up to 4 ids of characters saved in your FXI account (find ids with list_characters). | |
| idempotency_key | No | Optional. Reuse the same key to retry safely: the earlier result is returned and nothing is charged twice. | |
| wait_for_completion | No | When true, waits a short while for the clip before returning. get_task reports progress either way. | |
| opening_image_upload | No | Optional asset_url of an image you uploaded (create_upload_url, upload_from_url or upload_media_data) to use as the opening frame. Use this or atmosphere_id, not both. | |
| target_duration_seconds | No | Desired length in seconds. The clip is at most 12 seconds; longer values are shortened to 12. |