Captions

Preview a caption style on one frame

Renders a single JPG with sample text in a style over your video — to choose a look before rendering the whole video. Takes ~2 seconds.

Billing: One image · Rate limit: 30/min · Asynchronous

post/v1/studio/captions/preview

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/studio/captions/preview
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

x-wait-msinteger

Wait for the job inside this call (ms)

Request body

atnumber

seconds into the video

fit'crop' | 'blur' | 'pad'
textstring

Sample caption text

video_urlstring uri required

Public URL of the source video (mp4, mov, webm, mkv…) — or the url of a previous render

resolution'480' | '720' | '1080' | 'source'
aspect_ratio'original' | '9:16' | '16:9' | '1:1' | '4:5' | '4:3'

Response

Completed (or 202 while processing)

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
outputobject

Operation result (see each operation). While a Studio render is processing: stage (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), phase (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), progress (a percent, 0–100) and progress_fraction (0–1), eta_seconds (seconds left, never below 0) and estimate_seconds

errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.