Get Subtitle

curl --request GET \
  --url https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles \
  --header 'X-API-Key: <api-key>'

{
  "participantNames": [
    "<string>"
  ],
  "subtitles": [
    {
      "id": "<string>",
      "speaker": "<string>",
      "time_begin": 1,
      "time_end": 1,
      "words": [
        {
          "word": "<string>",
          "time_begin": 1,
          "time_end": 1,
          "is_eos": true
        }
      ],
      "language": "<string>",
      "text": "<string>",
      "metadata": {},
      "cue_settings": {}
    }
  ],
  "bgVolume": 123,
  "speakerVolumes": {},
  "speakerVoiceSettings": {}
}

Subtitles

Get Subtitle

Retrieve the structured subtitle segments of a recording’s language track in JSON form (with word-level timings). The response shape mirrors the PUT request body — use this before PUT to fetch the current segments, modify the field(s) you want to change (typically text or words[].word), and send the full array back. The source and dubbing query flags pick which track to read: source transcription, target translation, or dubbing.

Language scoping

The language value must match the requested task type for the recording:

When source=true and dubbing=false (transcription), language must equal the recording source language.
When source=false and dubbing=false (translation), language must be one of the recording translation languages.
When source=false and dubbing=true (dubbing), language must be one of the recording translation languages.
source=true and dubbing=true together is invalid.

Mismatched combinations return 400 with a descriptive message rather than reaching the underlying file lookup.

GET

projects

{projectId}

recordings

{recordingId}

subtitles

Get Subtitle

curl --request GET \
  --url https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles \
  --header 'X-API-Key: <api-key>'

{
  "participantNames": [
    "<string>"
  ],
  "subtitles": [
    {
      "id": "<string>",
      "speaker": "<string>",
      "time_begin": 1,
      "time_end": 1,
      "words": [
        {
          "word": "<string>",
          "time_begin": 1,
          "time_end": 1,
          "is_eos": true
        }
      ],
      "language": "<string>",
      "text": "<string>",
      "metadata": {},
      "cue_settings": {}
    }
  ],
  "bgVolume": 123,
  "speakerVolumes": {},
  "speakerVoiceSettings": {}
}

Authorizations

X-API-Key

string

header

required

Path Parameters

projectId

string<uuid>

required

Project ID

recordingId

string<uuid>

required

Recording ID

Query Parameters

language

string

required

BCP-47 language code of the track to read

source

boolean

default:false

Set to true to read the source (transcription) track

dubbing

boolean

default:false

Set to true to read the dubbing track

Response

Subtitle track returned

participantNames

string[]

required

subtitles

object[]

required

Show child attributes

bgVolume

number

speakerVolumes

object

Show child attributes

speakerVoiceSettings

object

Show child attributes

Get Subtitle Profiles Update Subtitle

⌘I