Transcribe and burn subtitles

Auto-transcribe the audio and burn styled subtitles onto the video. Async — returns 202 with a pending job; poll GET /tool_jobs/{uid} until status is completed or failed.

post/tools/subtitle_video

Request body

video_urlstring uri required

Video URL

language'' | 'en' | 'es' | 'fr' | 'de' | 'it' | 'pt' | 'nl' | 'ru' | 'pl' | 'tr' | 'ar' | 'hi' | 'zh' | 'ja' | 'ko' | 'id' | 'vi' | 'th'

Auto detect works well when the audio is clear

words_per_segment1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 nullable

Words on screen at once

Defaults to Inter

font_sizeinteger

Defaults to 28

colorstring

Defaults to white

bold'off' | 'on'

Bold

italic'off' | 'on'

Italic

alignment'2' | '1' | '3' | '5' | '4' | '6' | '8' | '7' | '9'

Defaults to Bottom Center

outline_widthinteger

Text outline width or box padding

outline_colorstring

Defaults to black

shadow_sizeinteger

Hard drop shadow, offset down-right

shadow_colorstring

Defaults to black

background_style'none' | 'box'

Solid box puts an opaque panel behind the text

background_colorstring

The colour of the box behind the text

background_opacityinteger

0 is fully transparent, 100 fully opaque

metadatastring

Arbitrary metadata string stored with the tool run

Response

Tool run accepted

uidstring

tool'subtitle_video'

status'pending' | 'running' | 'completed' | 'failed'

pending → running → completed / failed

progressinteger

0-100 job progress, 100 once completed

inputsobject

Inputs the job was created with

metadatastring nullable

Arbitrary metadata string round-tripped from the create request

selfstring uri

created_atstring date-time

completed_atstring date-time nullable

error_messagestring nullable

Human-readable failure reason (only present on failed jobs)

Changes

No recorded changes to this endpoint across all 1 revision of this API.