Get Project Detail - TranscribeTube

cURL

curl --request GET \
  --url https://api.transcribetube.com/api/detail/{id} \
  --header 'api-key: <api-key>'

import requests

url = "https://api.transcribetube.com/api/detail/{id}"

headers = {"api-key": "<api-key>"}

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

print(response.text)

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

fetch('https://api.transcribetube.com/api/detail/{id}', 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.transcribetube.com/api/detail/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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.transcribetube.com/api/detail/{id}"

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

	req.Header.Add("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.transcribetube.com/api/detail/{id}")
  .header("api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.transcribetube.com/api/detail/{id}")

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "youtubeId": "<string>",
  "language": "en",
  "text": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

GET

api

detail

{id}

cURL

curl --request GET \
  --url https://api.transcribetube.com/api/detail/{id} \
  --header 'api-key: <api-key>'

import requests

url = "https://api.transcribetube.com/api/detail/{id}"

headers = {"api-key": "<api-key>"}

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

print(response.text)

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

fetch('https://api.transcribetube.com/api/detail/{id}', 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.transcribetube.com/api/detail/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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.transcribetube.com/api/detail/{id}"

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

	req.Header.Add("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.transcribetube.com/api/detail/{id}")
  .header("api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.transcribetube.com/api/detail/{id}")

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "youtubeId": "<string>",
  "language": "en",
  "text": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

Fetch a single project’s status and (if ready) its transcription text. Use this to poll for completion — see Lifecycle & Polling.

Request

Param	In	Type	Default	Description
`id`	path	string	—	The `projectId` returned by `POST /api/transcribeVideo`.
`showTimecode`	query	boolean	`false`	Include `[HH:MM:SS.sss]` timecodes in the `text` field (only applies when state is `done`).
`showSpeaker`	query	boolean	`false`	Include `Speaker N:` labels in the `text` field.
`showTranscription`	query	boolean	`true`	If `false`, omits the full transcript JSON (currently ignored by the API view but reserved).

Examples

curl "https://api.transcribetube.com/api/detail/f3c1e7a0-2b48-4a91-8a30-9b1c2d3e4f50" \
  -H "api-key: $TRANSCRIBETUBE_API_KEY"

curl "https://api.transcribetube.com/api/detail/f3c1e7a0-…?showTimecode=true&showSpeaker=true" \
  -H "api-key: $TRANSCRIBETUBE_API_KEY"

const res = await fetch(
  `https://api.transcribetube.com/api/detail/${projectId}`,
  { headers: { "api-key": process.env.TRANSCRIBETUBE_API_KEY } }
);
const project = await res.json();
if (project.state === "done") {
  console.log(project.text);
}

Response

The response shape depends on the project’s state.

When `state` is `done`

{
  "id": "f3c1e7a0-2b48-4a91-8a30-9b1c2d3e4f50",
  "name": "Rick Astley - Never Gonna Give You Up",
  "youtubeId": "dQw4w9WgXcQ",
  "language": "en",
  "text": "We're no strangers to love\n\nYou know the rules and so do I\n\n..."
}

Field	Type	Description
`id`	string	Project ID.
`name`	string	Video title.
`youtubeId`	string	The YouTube video ID.
`language`	string	Language code.
`text`	string	Plain-text transcription. Paragraphs separated by `\n\n`. With `showTimecode=true`, each paragraph is prefixed by `[HH:MM:SS.sss]`; with `showSpeaker=true`, by `Speaker N:`.

The done shape does not include the state field. If you’re branching on state, also check for the presence of text to confirm completion.

When `state` is `upload` or `transcription`

{
  "id": "f3c1e7a0-2b48-4a91-8a30-9b1c2d3e4f50",
  "name": "Rick Astley - Never Gonna Give You Up",
  "state": "transcription",
  "message": "Transcription is in progress",
  "videoLength": 213,
  "createdAt": "2026-01-15T14:30:00.000Z"
}

Field	Type	Description
`state`	enum	`upload` or `transcription`.
`message`	string	Human-readable status.
`videoLength`	integer	Length in seconds.
`createdAt`	string (ISO 8601)	When the project was created.

Errors

Status	When
401	Missing or invalid `api-key` header.
404	Project not found, or it belongs to a different user.

Authorizations

api-key

string

header

required

Path Parameters

string

required

The ID of the project to retrieve

Query Parameters

showTimecode

boolean

default:false

Show Timecode on content

showSpeaker

boolean

default:false

Show Speaker name on content

showTranscription

boolean

default:true

Show Transcription word by word

Response

Project detail. Shape depends on state.

Option 1
Option 2

Returned when state is 'done'

string<uuid>

name

string

youtubeId

string

language

string

Example:

"en"

text

string

Paragraphs joined by \n\n. Includes timecodes/speakers if requested.

List Projects

​Request

​Examples

​Response

​When state is done

​When state is upload or transcription

​Errors

Authorizations

Path Parameters

Query Parameters

Response

Request

Examples

Response

When `state` is `done`

When `state` is `upload` or `transcription`

Errors