Render Clip Tool
render_clipProduce a final captioned render of one viral moment. Pass the video id
and the moment's viral_moment id (both hashids from list_clips), and an
optional caption_preset (a supported preset key; invalid keys are rejected).
This is an EXPLICIT, on-demand render: calling it (re)renders the moment now.
If a rendered clip already exists it is REPLACED — e.g. call again with a
different caption_preset to re-render in a new style. To just read an
existing render, use get_render_status or list_clips instead.
Rendering is ASYNCHRONOUS: this returns status: "rendering" once dispatched
— then poll get_render_status with the same ids until it reports completed
and a rendered_clip URL. Safe to retry: a render already in flight returns
rendering without starting a second one. not_dispatched means a
precondition wasn't met (no preview clip, or the renderer isn't configured).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| video | Yes | The video id (hashid) from list_videos / list_clips. | |
| viral_moment | Yes | The viral moment id (hashid) from list_clips. | |
| caption_preset | No | Optional caption preset key applied to the render (invalid keys are rejected). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| video | Yes | The video id (hashid) the render belongs to. | |
| status | Yes | `rendering` means a render is in flight (poll get_render_status); `not_dispatched` means a precondition was not met, so nothing is in flight. | |
| viral_moment | Yes | The rendered viral moment id (hashid). Poll get_render_status with these two ids. |