BRbraiv
Transcripts

Get a subtitle file

Generates a temporary download URL for an SRT or WebVTT file in the requested source or translated language. Required scope: transcripts:read.

get/videos/{videoId}/subtitles/{lang}

Request

  • Base URL
    https://api.braiv.co/v1
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

videoIdstring required

Braiv library video document ID.

langstring required

ISO-style language or locale code accepted by the underlying product.

Example:en

Target language code used by the video, such as es or pt-BR.

Query parameters

format'srt' | 'vtt'

srt returns SubRip text; vtt returns WebVTT text.

Subtitle file format: srt returns a SubRip file for editors and general playback tools; vtt returns a WebVTT file for HTML5 players and web applications.

Response

Subtitle file is ready.

status'ready' required

Confirms the subtitle artifact is ready.

videoIdstring required

Parent library video ID.

languagestring required

ISO-style language or locale code accepted by the underlying product.

format'srt' | 'vtt' required

Returned subtitle serialization.

downloadUrlstring uri required

Temporary subtitle file URL.

Example response

{
  "language": "en"
}

Changes

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