Execute Video Workflow

Execute video workflow

curl --request POST \
  --url https://api.videodb.io/video/{video_id}/workflow/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "workflow_type": "transcribe",
  "config": {
    "language": "en",
    "model": "gpt-4"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({workflow_type: 'transcribe', config: {language: 'en', model: 'gpt-4'}})
};

fetch('https://api.videodb.io/video/{video_id}/workflow/', 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}/workflow/",
  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([
    'workflow_type' => 'transcribe',
    'config' => [
        'language' => 'en',
        'model' => 'gpt-4'
    ]
  ]),
  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}/workflow/"

	payload := strings.NewReader("{\n  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\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}/workflow/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\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}/workflow/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "workflow_type": "transcribe",
  "config": {
    "language": "en",
    "model": "gpt-4"
  }
}'

import Foundation

let parameters = [
  "workflow_type": "transcribe",
  "config": [
    "language": "en",
    "model": "gpt-4"
  ]
] as [String : Any?]

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

let url = URL(string: "https://api.videodb.io/video/{video_id}/workflow/")!
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}/workflow/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\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}/workflow/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\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({workflow_type: 'transcribe', config: {language: 'en', model: 'gpt-4'}})
};

fetch('https://api.videodb.io/video/{video_id}/workflow/', 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}/workflow/");

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  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\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}/workflow/");

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  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\n}");

CURLcode ret = curl_easy_perform(hnd);

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\n}")
val request = Request.Builder()
  .url("https://api.videodb.io/video/{video_id}/workflow/")
  .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}

workflow

Execute video workflow

curl --request POST \
  --url https://api.videodb.io/video/{video_id}/workflow/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "workflow_type": "transcribe",
  "config": {
    "language": "en",
    "model": "gpt-4"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({workflow_type: 'transcribe', config: {language: 'en', model: 'gpt-4'}})
};

fetch('https://api.videodb.io/video/{video_id}/workflow/', 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}/workflow/",
  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([
    'workflow_type' => 'transcribe',
    'config' => [
        'language' => 'en',
        'model' => 'gpt-4'
    ]
  ]),
  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}/workflow/"

	payload := strings.NewReader("{\n  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\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}/workflow/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\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}/workflow/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "workflow_type": "transcribe",
  "config": {
    "language": "en",
    "model": "gpt-4"
  }
}'

import Foundation

let parameters = [
  "workflow_type": "transcribe",
  "config": [
    "language": "en",
    "model": "gpt-4"
  ]
] as [String : Any?]

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

let url = URL(string: "https://api.videodb.io/video/{video_id}/workflow/")!
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}/workflow/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\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}/workflow/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\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({workflow_type: 'transcribe', config: {language: 'en', model: 'gpt-4'}})
};

fetch('https://api.videodb.io/video/{video_id}/workflow/', 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}/workflow/");

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  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\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}/workflow/");

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  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\n}");

CURLcode ret = curl_easy_perform(hnd);

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"workflow_type\": \"transcribe\",\n  \"config\": {\n    \"language\": \"en\",\n    \"model\": \"gpt-4\"\n  }\n}")
val request = Request.Builder()
  .url("https://api.videodb.io/video/{video_id}/workflow/")
  .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"
  }
}

Apply complex video processing workflows such as adding subtitles, overlays, or other transformations.

import videodb
from videodb import SubtitleStyle

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

# Add subtitles to video
subtitle_style = SubtitleStyle(
    background_color="#000000",
    text_color="#FFFFFF"
)
stream_url = video.add_subtitle(subtitle_style)

print(f"Video with subtitles: {stream_url}")

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];

// Add subtitles to video
const streamUrl = await video.addSubtitle({
  backgroundColor: '#000000',
  textColor: '#FFFFFF'
});

console.log(`Video with subtitles: ${streamUrl}`);

Supports multiple workflow types (subtitles currently implemented)
Workflows modify video stream without changing original
Subtitle style customization includes colors, positioning, and fonts
Returns new stream URL with applied workflow
Original video remains unchanged

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

workflow_type

enum<string>

required

Available options:

transcribe,

index,

analyze

Example:

"transcribe"

config

object

Show child attributes

Response

200 - application/json

Workflow started

success

boolean

Example:

true

status

enum<string>

Available options:

processing,

done,

failed

Example:

"processing"

data

object

Show child attributes

Create Video Clip Reframe Video

⌘I

Overview

Authentication

Collections

Videos

Streaming & Playback

Transcription

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