Get Subtitle

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

import requests

url = "https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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, edit the words array of the segment(s) you want to change (word-level text and timings are the source of truth; editing text alone has no effect), 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>'

import requests

url = "https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/subtitles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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

Guides

API Documentation

Get Subtitle

Language scoping

Authorizations

Path Parameters

Query Parameters

Response