Get Dubbing Transcript

GET

transcript

{run_id}

{language}

Get Dubbed Run Transcript

curl --request GET \
  --url https://client.camb.ai/apis/transcript/{run_id}/{language} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://client.camb.ai/apis/transcript/{run_id}/{language}"

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://client.camb.ai/apis/transcript/{run_id}/{language}', 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://client.camb.ai/apis/transcript/{run_id}/{language}",
  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;
}

This endpoint serves as a bridge between your media content and its written representation. When you’ve completed a dubbing run using Camb.ai’s powerful dubbing technology, it gives you access to all that valuable spoken content in text form, unlocking new possibilities for how you can use and share your content.

The {language} path parameter is your language selector. It determines which linguistic version of your transcript you’ll receive - you can choose either the original source language or any of the target languages you’ve dubbed your content into.

Understanding Response Options

The transcript endpoint gives you two distinct ways to receive your transcript data, each designed for different implementation scenarios:

Direct content delivery (data_type=raw_data): The transcript text comes straight to you in the HTTP response body. This immediate delivery is perfect for when you need to process or display the text right away in your application.
File-based delivery (data_type=file): You receive a pre-signed URL that links to a ready-to-download transcript file. This approach works wonderfully when you need to store, share, or download the transcript as a distinct file.

Your choice between these options depends on your workflow and how you intend to use the transcript data in your application.

Choosing the Right Format for Your Needs

Transcripts come in three carefully designed formats, each optimized for different applications:

Format	Description	Ideal Applications
`txt` (default)	Clean, simple plain text without timing information	Content analysis, text extraction, SEO optimization, and general reading
`srt`	SubRip Subtitle format with precise timestamps	Professional video editing software, most desktop video players, and subtitle embedding
`vtt`	WebVTT format optimized for web environments	HTML5 video players, web applications, and accessibility compliance on websites

The format you choose should align with how you plan to use the transcript. For example, if you’re adding subtitles to a web video player, WebVTT (vtt) would be your best choice because of its native support in HTML5 environments. If you’re editing in professional software like Adobe Premiere, the srt format would integrate more seamlessly with your workflow.

Implementation Example: Bringing It All Together

Let’s walk through a complete example of how you might implement transcript retrieval in your application. This Python code sample demonstrates the process from request to application:

import requests
import os

# Your authentication and identification details
API_KEY = "your_api_key_here"
RUN_ID = 12345  
LANGUAGE = 1  # Language ID (e.g., `1` for English-United States)

# Set up your request parameters
url = f"https://client.camb.ai/apis/transcript/{RUN_ID}/{LANGUAGE}"
headers = {"x-api-key": API_KEY}
params = {
    "format_type": "vtt",  # Choosing WebVTT for web video integration
    "data_type": "file"    # Getting a downloadable file
}

# Make the request to the Camb.ai API
response = requests.get(url, headers=headers, params=params)

# Process the response based on its status
if response.status_code == 200:
    if params["data_type"] == "file":
        # Extract the file URL from the response
        file_url = response.json()["transcript"]
        print(f"Success! Transcript file available at: {file_url}")
        
        # Download the transcript file to your local environment
        transcript_response = requests.get(file_url)
        
        # Save the file with appropriate naming
        filename = f"transcript_{RUN_ID}_{LANGUAGE}.{params['format_type']}"
        with open(filename, "wb") as f:
            f.write(transcript_response.content)
            
        print(f"Transcript downloaded and saved as {filename}")
    else:
        # For direct content, display or process the text
        print("Transcript content retrieved successfully:")
        
        # Here you might process the text further, such as:
        # - Storing in a database
        # - Analyzing for keywords
        # - Displaying in your application interface
        
        # For this example, we'll just show the first 150 characters
        preview = response.text[:150] + "..." if len(response.text) > 150 else response.text
        print(f"Preview: {preview}")
else:
    # Handle any errors that might occur
    print(f"Error {response.status_code}: Could not retrieve transcript")
    print(f"Details: {response.text}")

This code not only retrieves your transcript but also demonstrates proper error handling and different processing paths based on your chosen response type. Notice how we create a meaningful filename that includes both the run ID and language - this kind of attention to detail helps keep your transcripts organized when working with multiple videos or languages.

Building a Complete Workflow

The transcript endpoint works best as part of a complete content processing workflow. Consider how it connects with these related endpoints:

Create Dubbing Run - Start the process by submitting your video for dubbing
Check Dubbing Status - Monitor progress and determine when your transcript will be available
Get Dubbed Media - Retrieve the dubbed media that corresponds to your transcript

By combining these endpoints, you can create powerful automation workflows that transform, translate, and repurpose your content with minimal manual intervention.

Authorizations

x-api-key

string

header

required

The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.

Path Parameters

run_id

integer

required

The unique identifier for the run, which was generated during the creation process and returned upon task completion.

language

string

required

Language for this run. Pass a locale tag (en-us, fr-fr, es-es). Numeric language IDs still work but are deprecated. See all source languages.

Example:

"en-us"

Query Parameters

format_type

enum<string>

default:txt

The format to use for the transcription output. Either srt, vtt or txt. Defaults to txt.

Available options:

srt,

vtt,

txt

data_type

enum<string>

default:file

The data type for the transcription being returned. Returns the raw data of the transcription or a presigned url for the file that contains the transcript contents in the specified format.

Available options:

raw_data,

file

Get Dubbed Output in Alt FormatFetches the dubbed output for a specified `run_id` and `language` in the file format that is provided in the request body.

Get Dubbed Run Transcript

curl --request GET \
  --url https://client.camb.ai/apis/transcript/{run_id}/{language} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://client.camb.ai/apis/transcript/{run_id}/{language}"

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://client.camb.ai/apis/transcript/{run_id}/{language}', 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://client.camb.ai/apis/transcript/{run_id}/{language}",
  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;
}

Getting Started

Models

Tutorials

SDK Guides

Hosting Platforms

Integrations

API Reference

Other Products

Release Logs

Get Dubbing Transcript

Understanding Response Options

Choosing the Right Format for Your Needs

Implementation Example: Bringing It All Together

Building a Complete Workflow

Authorizations

Path Parameters

Query Parameters

​Understanding Response Options

​Choosing the Right Format for Your Needs

​Implementation Example: Bringing It All Together

​Building a Complete Workflow

Authorizations

Path Parameters

Query Parameters

Understanding Response Options

Choosing the Right Format for Your Needs

Implementation Example: Bringing It All Together

Building a Complete Workflow