Create caption job
create_caption_jobStart adding animated captions to a video. Provide ONE source:
source_url: a public direct link to the video file;
filename + file_size: returns a presigned upload URL; PUT the raw bytes there with the returned Content-Type header, then call start_caption_job. Optionally choose style, position (top/middle/bottom or position_x/position_y in %), colours, font size, animation. Returns the job_id. Then call wait_for_caption_job and download_captioned_video.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| style | No | Caption style id from list_caption_styles, e.g. "beast" (default), "punch" (Hormozi), "neon", "nova". | |
| filename | No | For uploading the file yourself: file name (.mp4/.mov). Requires file_size. Returns an upload URL to PUT the bytes to, then call start_caption_job. | |
| language | No | Spoken language code, or "auto" (default). | |
| position | No | Where the captions sit. Default: middle. Ignored when position_y is set. | |
| theme_id | No | Apply one of the account's saved caption themes. | |
| animation | No | ||
| file_size | No | Size in bytes (required with filename). | |
| font_size | No | ||
| uppercase | No | ||
| position_x | No | Custom horizontal centre of the captions, % of frame width (default 50). | |
| position_y | No | Custom vertical centre of the captions, % of frame height (0 = top, 100 = bottom). | |
| source_url | No | Public direct link to an .mp4/.mov file (not a web page). The service downloads it. | |
| font_family | No | Font family; see list_caption_styles → customization.font_family for allowed values. | |
| stroke_color | No | ||
| primary_color | No | Base text colour, hex (e.g. #FFFFFF). | |
| ai_highlighter | No | Automatically highlight key words. | |
| highlight_color | No | Accent colour for highlighted keywords, hex. | |
| background_color | No | Background block colour (hex) or "transparent". | |
| active_word_color | No | Colour of the word currently being spoken, hex. |