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 body

captionFontFamilystring

Subtitle font family. On write, one of Tella's catalog font families (the list the editor's font picker offers, and the same one fontFamily accepts on text overlays), or the video's current family to keep an uploaded font. Reads report the family the subtitles render with, which on videos styled before the catalog can be a legacy bundled family such as Arial.

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

Variable-font weight axis — 100 (thin) to 1000. Clamped to the range the family supports, so a read reports 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

Changed in 2 of the 18 revisions of this API.91

    • ●

      added the new edit_conflict enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new edit_conflict enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new edit_conflict enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new edit_conflict enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new edit_conflict enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new edit_conflict enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new edit_conflict enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new edit_conflict enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new edit_conflict enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      endpoint added

      endpoint-added

Of the 18 revisions, 1 has no diff computed.