Get Video Context
curl --request GET \
--url https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/context \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/context"
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}/context', 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}/context",
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}/context"
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}/context")
.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}/context")
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{
"contextHint": "This is a sunscreen commercial for a product called 'ACE SUN SPORT'. Numbers like 'SPF 50' are product specifications and should be preserved as such.",
"scenes": [
{
"description": "A solid green background is displayed.",
"start": 0,
"end": 1
},
{
"description": "A solid green background with the text 'ACE SUN SPORT' in the middle.",
"start": 1,
"end": 5
}
],
"generatedAt": "2026-11-10T19:08:01.040Z"
}Recordings
Get Video Context
Returns what the video shows, so that tools that only read text (translation, quality checks, assistants) can take it into account.
The context is created when transcription runs with video analysis enabled, so recordings that were never analysed answer 404 with the reason. Pull it when you need it; Studio does not push it anywhere.
contextHintUserEdited is only present after a user has rewritten the detected contextHint in Studio; when it is present, prefer it over contextHint.
On-screen text is not part of this response. It is a regular segment of the subtitle tracks (speaker On Screen Text, see metadata.onScreenText).
GET
/
v1
/
projects
/
{projectId}
/
recordings
/
{recordingId}
/
context
Get Video Context
curl --request GET \
--url https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/context \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.studio.us.phrase.com/v1/projects/{projectId}/recordings/{recordingId}/context"
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}/context', 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}/context",
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}/context"
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}/context")
.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}/context")
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{
"contextHint": "This is a sunscreen commercial for a product called 'ACE SUN SPORT'. Numbers like 'SPF 50' are product specifications and should be preserved as such.",
"scenes": [
{
"description": "A solid green background is displayed.",
"start": 0,
"end": 1
},
{
"description": "A solid green background with the text 'ACE SUN SPORT' in the middle.",
"start": 1,
"end": 5
}
],
"generatedAt": "2026-11-10T19:08:01.040Z"
}Response
Video context returned
What the video shows, produced by analysing the video during transcription.
Was this page helpful?