Skip to main content
GET
/
api
/
transcripts
Get a source-video transcript
curl --request GET \
  --url https://api.opus.pro/api/transcripts \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.opus.pro/api/transcripts"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.opus.pro/api/transcripts', 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.opus.pro/api/transcripts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$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.opus.pro/api/transcripts"

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

req.Header.Add("Authorization", "Bearer <token>")

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.opus.pro/api/transcripts")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.opus.pro/api/transcripts")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": [
    [
      {
        "id": 0,
        "start": 0,
        "end": 10.5,
        "text": "Hello and welcome to the show.",
        "words": [
          {
            "word": "hello",
            "start": 0.12,
            "end": 0.48,
            "isFillerWord": false
          }
        ],
        "speaker": "SPEAKER_00"
      }
    ]
  ]
}
For API callers on a range-limited project, paragraphs are filtered to the billed curation range (the portion the user paid to clip). Internal callers and full-source submissions get the full transcript.

TranscriptExportParagraph

Reference the paragraph object returned in the transcript.

TranscriptExportWord

Reference the per-word timing object inside each paragraph.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

q
enum<string>
required

Query variant. Public callers must pass findByProjectId.

Available options:
findByProjectId
projectId
string
required

Project ID.

Example:

"P2120900kDmP"

Response

200 - application/json

Wrapper for the transcript response. data[0] is the transcript, or null when the project has no transcript yet.

data
(object[] | null)[]