Subtitles API Reference

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to veed/subtitles.

Default: veed/subtitles

Optional<string>video

Upload or paste a URL to the video you want to subtitle.

Optional<string>srt_content

Paste raw SRT subtitle text. Alternative to srt_file_url. When provided, transcription is skipped.

Optional<string>customization

Optional preset overrides: vertical position, shadow intensity, and per-tier text styling (font, weight, hex colour) for each word-importance tier. Any omitted field keeps the preset's default.

Optional<string>preset

Each style defines fonts, colors, layout, and animation. Two tiers with different pricing: - Dynamic presets (2x multiplier): glass, whisper, glide2, fusion, glide, terminal, handwritten. Richer, context-aware rendering that adapts to the input. - Basic presets (1x multiplier): simple, plain, beans, corpo, boo, shadeplay, casper, capri, lowkey, vinta, diego, ali, slay, kitty, hustle, karl, sprout, flex, mint, rizz, vegas. Fixed, lightweight styling with predictable output.

Allowed values: glass, whisper, glide2, fusion, glide, terminal, handwritten, simple, plain, beans, corpo, boo, shadeplay, casper, capri, lowkey, vinta, diego, ali, slay, kitty, hustle, karl, sprout, flex, mint, rizz, vegas

Optional<string>language

Improves transcription accuracy, and should match the source audio (not output subtitles).

Allowed values: af-ZA, am-ET, ar-AE, ar-BH, ar-DZ, ar-EG, ar-IL, ar-IQ, ar-JO, ar-KW, ar-LB, ar-MA, ar-OM, ar-PS, ar-QA, ar-SA, ar-TN, ast-ES, az-AZ, ba, bas, be-BY, bg-BG, br, bs-BA, ca-ES, ceb-PH, ckb-IQ, cs-CZ, cy-GB, da-DK, de-DE, dyu, el-GR, en-AU, en-GB, en-IN, en-NZ, en-US, eo, es-AR, es-BO, es-CL, es-CO, es-CR, es-DO, es-EC, es-ES, es-GT, es-HN, es-MX, es-NI, es-PA, es-PE, es-PR, es-PY, es-SV, es-US, es-UY, es-VE, et-EE, eu-ES, fa-IR, ff, fi-FI, fil-PH, fo, fr-CA, fr-FR, fy, ga, gd, gl-ES, ha-NG, haw, he-IL, hr-HR, hsb, ht, hu-HU, hy-AM, id-ID, ig, is-IS, it-IT, ja-JP, ja-Latn-JP, jv-ID, ka-GE, kab, kam-KE, kea-CV, kk-KZ, ko-KR, ku, ky-KG, la, lb-LU, lg, lij, ln-CD, lo-LA, lt-LT, luo-KE, lv-LV, mg, mi-NZ, mk-MK, mn-MN, ms-MY, mt-MT, nb-NO, nl-NL, nn, nso-ZA, ny-MW, oc-FR, pl-PL, ps-AF, pt-BR, pt-PT, ro-RO, roh, ru-RU, rw-RW, sah, sk-SK, sl-SI, sm, sn-ZW, so-SO, sq-AL, sr-Latn-RS, sr-RS, srd, ss, su-ID, sv-SE, sw-KE, sw-TZ, tg-TJ, th-TH, tk, tn, tok, ton, tr-TR, ts-ZA, tt, uk-UA, umb-AO, ur-IN, ur-PK, uz-UZ, vi-VN, vro, wo-SN, xh-ZA, yi, yo-NG, yue-Hant-HK, zh, zh-HK, zh-TW, zu-ZA

Optional<string>srt_file_url

Upload or paste a URL to your .srt subtitles file. When provided, transcription is skipped.

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: video-to-video

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async