Create Video Transcription

Generate video transcription

curl --request POST \
  --url https://api.videodb.io/video/{video_id}/transcription/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "engine": "default",
  "force": false,
  "language_code": "en-US",
  "callback_url": "https://webhook.example.com/callback",
  "callback_data": {}
}
'

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    engine: 'default',
    force: false,
    language_code: 'en-US',
    callback_url: 'https://webhook.example.com/callback',
    callback_data: {}
  })
};

fetch('https://api.videodb.io/video/{video_id}/transcription/', 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.videodb.io/video/{video_id}/transcription/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'engine' => 'default',
    'force' => false,
    'language_code' => 'en-US',
    'callback_url' => 'https://webhook.example.com/callback',
    'callback_data' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-token: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.videodb.io/video/{video_id}/transcription/"

	payload := strings.NewReader("{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-access-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.videodb.io/video/{video_id}/transcription/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.videodb.io/video/{video_id}/transcription/")

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

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}"

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

$headers=@{}
$headers.Add("x-access-token", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.videodb.io/video/{video_id}/transcription/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "engine": "default",
  "force": false,
  "language_code": "en-US",
  "callback_url": "https://webhook.example.com/callback",
  "callback_data": {}
}'

import Foundation

let parameters = [
  "engine": "default",
  "force": false,
  "language_code": "en-US",
  "callback_url": "https://webhook.example.com/callback",
  "callback_data": []
] as [String : Any?]

let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])

let url = URL(string: "https://api.videodb.io/video/{video_id}/transcription/")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
  "x-access-token": "<api-key>",
  "Content-Type": "application/json"
]
request.httpBody = postData

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/video/{video_id}/transcription/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/video/{video_id}/transcription/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    engine: 'default',
    force: false,
    language_code: 'en-US',
    callback_url: 'https://webhook.example.com/callback',
    callback_data: {}
  })
};

fetch('https://api.videodb.io/video/{video_id}/transcription/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/video/{video_id}/transcription/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}");

CURLcode ret = curl_easy_perform(hnd);

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/video/{video_id}/transcription/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}");

CURLcode ret = curl_easy_perform(hnd);

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}")
val request = Request.Builder()
  .url("https://api.videodb.io/video/{video_id}/transcription/")
  .post(body)
  .addHeader("x-access-token", "<api-key>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

{
  "success": true,
  "status": "processing",
  "data": {
    "id": "job-123",
    "output_url": "https://api.videodb.io/async-response/job-123"
  }
}

POST

video

{video_id}

transcription

Generate video transcription

curl --request POST \
  --url https://api.videodb.io/video/{video_id}/transcription/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "engine": "default",
  "force": false,
  "language_code": "en-US",
  "callback_url": "https://webhook.example.com/callback",
  "callback_data": {}
}
'

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    engine: 'default',
    force: false,
    language_code: 'en-US',
    callback_url: 'https://webhook.example.com/callback',
    callback_data: {}
  })
};

fetch('https://api.videodb.io/video/{video_id}/transcription/', 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.videodb.io/video/{video_id}/transcription/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'engine' => 'default',
    'force' => false,
    'language_code' => 'en-US',
    'callback_url' => 'https://webhook.example.com/callback',
    'callback_data' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-token: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.videodb.io/video/{video_id}/transcription/"

	payload := strings.NewReader("{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-access-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.videodb.io/video/{video_id}/transcription/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.videodb.io/video/{video_id}/transcription/")

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

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}"

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

$headers=@{}
$headers.Add("x-access-token", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.videodb.io/video/{video_id}/transcription/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "engine": "default",
  "force": false,
  "language_code": "en-US",
  "callback_url": "https://webhook.example.com/callback",
  "callback_data": {}
}'

import Foundation

let parameters = [
  "engine": "default",
  "force": false,
  "language_code": "en-US",
  "callback_url": "https://webhook.example.com/callback",
  "callback_data": []
] as [String : Any?]

let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])

let url = URL(string: "https://api.videodb.io/video/{video_id}/transcription/")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
  "x-access-token": "<api-key>",
  "Content-Type": "application/json"
]
request.httpBody = postData

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/video/{video_id}/transcription/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/video/{video_id}/transcription/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    engine: 'default',
    force: false,
    language_code: 'en-US',
    callback_url: 'https://webhook.example.com/callback',
    callback_data: {}
  })
};

fetch('https://api.videodb.io/video/{video_id}/transcription/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/video/{video_id}/transcription/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}");

CURLcode ret = curl_easy_perform(hnd);

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/video/{video_id}/transcription/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}");

CURLcode ret = curl_easy_perform(hnd);

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"engine\": \"default\",\n  \"force\": false,\n  \"language_code\": \"en-US\",\n  \"callback_url\": \"https://webhook.example.com/callback\",\n  \"callback_data\": {}\n}")
val request = Request.Builder()
  .url("https://api.videodb.io/video/{video_id}/transcription/")
  .post(body)
  .addHeader("x-access-token", "<api-key>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

{
  "success": true,
  "status": "processing",
  "data": {
    "id": "job-123",
    "output_url": "https://api.videodb.io/async-response/job-123"
  }
}

Generate a complete transcription of the video’s audio content using automatic speech recognition.

import videodb

conn = videodb.connect(api_key="your_api_key")
coll = conn.get_collection()
video = coll.get_videos()[0]

# Generate transcript
result = video.generate_transcript()

if isinstance(result, dict) and result.get('success'):
    print("Transcript generated successfully")
else:
    print("Transcript generation started or already exists")

# Generate transcript with language hint
video.generate_transcript(language_code="en")

import { connect } from 'videodb';

const conn = connect({ apiKey: 'your_api_key' });
const coll = await conn.getCollection();
const videos = await coll.getVideos();
const video = videos[0];

// Generate transcript
const result = await video.generateTranscript();

console.log(`Success: ${result.success}`);
console.log(`Message: ${result.message}`);

// Generate transcript with language hint
await video.generateTranscript({ languageCode: 'en' });

Generates timestamped transcript with word-level timing information
Includes automatic speaker diarization when available
Returns success confirmation; retrieve actual transcript with get-transcription
Processing time depends on video duration
Transcript is cached after first generation (use force: true to regenerate)
Optional language_code parameter hints the transcription engine about the spoken language for better accuracy

Authorizations

x-access-token

string

header

required

API key for authentication (sk-xxx format)

Path Parameters

video_id

string

required

Pattern: ^m-

Example:

"m-12345"

Body

application/json

engine

string

default:default

Example:

"default"

force

boolean

Example:

false

language_code

string

Example:

"en-US"

callback_url

string

Example:

"https://webhook.example.com/callback"

callback_data

object

Response

200 - application/json

Transcription job started

Option 1
Option 2

success

boolean

Example:

true

status

enum<string>

Available options:

processing,

done,

failed

Example:

"processing"

data

object

Show child attributes

⌘I

Overview

Authentication

Collections

Videos

Streaming & Playback

Transcription

Search V2 & Ask

Indexing & Search

Scene & Frame Analysis

Advanced Operations

Audio

Images

AI Generation

Timeline & Compilation

Billing

Downloads

Utilities

Assets

Editor

Transcode

Meeting

Capture

RTStream

RTStream Transcription

RTStream Scene Indexing

RTStream Events & Alerts

Authorizations

Path Parameters

Body

Response