Videos

Save a subtitle preset

Saves a subtitle look as a personal preset, like the editor's "Save as preset". Pass videoId to snapshot that video's current subtitles (style, font, weight, size, position, grouping and lines per block), captionStyle to build one from scratch on the style's defaults, or both — explicit caption fields override the video's. Omit name for the editor's default (the matching built-in's name, numbered). The preset then appears in GET /v1/subtitle-presets and in the editor's Subtitles panel, and can be applied to other videos with PUT /v1/videos/{id}/subtitle-preset.

post/v1/subtitle-presets

Request

  • Base URL: https://api.tella.com
  • URL: https://api.tella.com/v1/subtitle-presets
  • Auth: HTTP bearer

Request body

captionFontFamilystring

Subtitle font family. On write, one of Tella's catalog font families or the built-in subtitle families Dela Gothic One, Lato, Georgia, and Arial, or the video's current family to keep an uploaded font. Reads report the family the subtitles render with.

captionFontSizenumber

Exact subtitle text size, 40 to 200 — the editor's Size slider. captionSize is the same setting in buckets (small 40, medium 64, large 80), so a request passes one or the other, not both.

captionFontWeightnumber

Subtitle font weight, 100 (thin) to 1000. Catalog fonts clamp to their supported range; built-in subtitle fonts outside the catalog snap to an available weight. Dela Gothic One uses 400 only; Arial uses 400 or 700. Reads report the weight that renders. Sent without captionFontFamily, it re-weights the video's current font.

captionGrouping'chunked' | 'singleWord'

How subtitle text is grouped: sentence chunks or one word at a time. Defaults to the video's, or chunked.

captionLinesPerBlockinteger

Lines a caption block may span when captionGrouping is chunked: 1, 2, or 3, or 0 for no limit, where blocks only break on pauses and sentence ends.

captionSize'small' | 'medium' | 'large'

Subtitle text size. Defaults to the video's, or the style's default. Pass this or captionFontSize, not both.

namestring

Preset name, as shown in the editor. Defaults to the matching built-in's name, numbered past any saved preset already using it.

videoIdstring

Video whose current subtitle look to start from. Omit to build the preset from captionStyle and the style's defaults.

Example request

{
  "captionFontFamily": "Inter",
  "captionFontSize": 64,
  "captionFontWeight": 500,
  "captionLinesPerBlock": 1,
  "captionStyle": {
    "activeWordTextColor": "#5E51F8FF",
    "backgroundColor": "#5E51F8FF",
    "highlightColor": "#5E51F8FF",
    "outlineColor": "#5E51F8FF",
    "shadowColor": "#5E51F8FF",
    "textColor": "#5E51F8FF"
  },
  "name": "Brand captions",
  "videoId": "vid_abc123"
}

Response

Preset saved

Example response

{
  "preset": {
    "captionStyle": {
      "activeWordTextColor": "#5E51F8FF",
      "backgroundColor": "#5E51F8FF",
      "highlightColor": "#5E51F8FF",
      "outlineColor": "#5E51F8FF",
      "shadowColor": "#5E51F8FF",
      "textColor": "#5E51F8FF"
    },
    "presetId": "default:spotlight"
  }
}

Changes

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