Compile Search Results

Compile media content

curl --request POST \
  --url https://api.videodb.io/compile/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "inputs": [
    {
      "media_id": "m-12345",
      "start_time": 10,
      "end_time": 30
    }
  ],
  "output_format": "mp4",
  "callback_url": "https://webhook.example.com/callback"
}
'

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    inputs: [{media_id: 'm-12345', start_time: 10, end_time: 30}],
    output_format: 'mp4',
    callback_url: 'https://webhook.example.com/callback'
  })
};

fetch('https://api.videodb.io/compile/', 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/compile/",
  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([
    'inputs' => [
        [
                'media_id' => 'm-12345',
                'start_time' => 10,
                'end_time' => 30
        ]
    ],
    'output_format' => 'mp4',
    'callback_url' => 'https://webhook.example.com/callback'
  ]),
  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/compile/"

	payload := strings.NewReader("{\n  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\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/compile/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.videodb.io/compile/")

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  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\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/compile/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "inputs": [
    {
      "media_id": "m-12345",
      "start_time": 10,
      "end_time": 30
    }
  ],
  "output_format": "mp4",
  "callback_url": "https://webhook.example.com/callback"
}'

import Foundation

let parameters = [
  "inputs": [
    [
      "media_id": "m-12345",
      "start_time": 10,
      "end_time": 30
    ]
  ],
  "output_format": "mp4",
  "callback_url": "https://webhook.example.com/callback"
] as [String : Any?]

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

let url = URL(string: "https://api.videodb.io/compile/")!
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/compile/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\n}", false);
var response = await client.PostAsync(request);

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

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/compile/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\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({
    inputs: [{media_id: 'm-12345', start_time: 10, end_time: 30}],
    output_format: 'mp4',
    callback_url: 'https://webhook.example.com/callback'
  })
};

fetch('https://api.videodb.io/compile/', 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/compile/");

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  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\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/compile/");

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  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\n}");

CURLcode ret = curl_easy_perform(hnd);

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\n}")
val request = Request.Builder()
  .url("https://api.videodb.io/compile/")
  .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

compile

Compile media content

curl --request POST \
  --url https://api.videodb.io/compile/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "inputs": [
    {
      "media_id": "m-12345",
      "start_time": 10,
      "end_time": 30
    }
  ],
  "output_format": "mp4",
  "callback_url": "https://webhook.example.com/callback"
}
'

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    inputs: [{media_id: 'm-12345', start_time: 10, end_time: 30}],
    output_format: 'mp4',
    callback_url: 'https://webhook.example.com/callback'
  })
};

fetch('https://api.videodb.io/compile/', 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/compile/",
  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([
    'inputs' => [
        [
                'media_id' => 'm-12345',
                'start_time' => 10,
                'end_time' => 30
        ]
    ],
    'output_format' => 'mp4',
    'callback_url' => 'https://webhook.example.com/callback'
  ]),
  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/compile/"

	payload := strings.NewReader("{\n  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\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/compile/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.videodb.io/compile/")

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  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\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/compile/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "inputs": [
    {
      "media_id": "m-12345",
      "start_time": 10,
      "end_time": 30
    }
  ],
  "output_format": "mp4",
  "callback_url": "https://webhook.example.com/callback"
}'

import Foundation

let parameters = [
  "inputs": [
    [
      "media_id": "m-12345",
      "start_time": 10,
      "end_time": 30
    ]
  ],
  "output_format": "mp4",
  "callback_url": "https://webhook.example.com/callback"
] as [String : Any?]

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

let url = URL(string: "https://api.videodb.io/compile/")!
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/compile/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\n}", false);
var response = await client.PostAsync(request);

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

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/compile/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\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({
    inputs: [{media_id: 'm-12345', start_time: 10, end_time: 30}],
    output_format: 'mp4',
    callback_url: 'https://webhook.example.com/callback'
  })
};

fetch('https://api.videodb.io/compile/', 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/compile/");

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  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\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/compile/");

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  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\n}");

CURLcode ret = curl_easy_perform(hnd);

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"inputs\": [\n    {\n      \"media_id\": \"m-12345\",\n      \"start_time\": 10,\n      \"end_time\": 30\n    }\n  ],\n  \"output_format\": \"mp4\",\n  \"callback_url\": \"https://webhook.example.com/callback\"\n}")
val request = Request.Builder()
  .url("https://api.videodb.io/compile/")
  .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"
  }
}

Compile search results or a list of videos/scenes into a single playable stream. Useful for creating compilations from search queries or combining specific video segments.

import videodb

conn = videodb.connect(api_key="your_api_key")
coll = conn.get_collection()

# Search for videos
search_results = coll.search(query="action scenes")

# Compile search results into a stream
stream_url = search_results.compile()

print(f"Compiled stream: {stream_url}")

import { connect } from 'videodb';

const conn = await connect({ apiKey: 'your_api_key' });
const coll = await conn.getCollection();

// Search for videos
const searchResults = await coll.search({ query: 'action scenes' });

// Compile search results into a stream
const streamUrl = await searchResults.compile();

console.log(`Compiled stream: ${streamUrl}`);

Compile is useful for creating highlight reels or compilations from search results
Each timeline entry needs video ID and time range (start, end in seconds)
Returns a playable stream URL
Compile automatically stitches segments together in order

Create Timeline v2

Advanced composition with multiple tracks

Search Collections

Find videos to compile

Authorizations

x-access-token

string

header

required

API key for authentication (sk-xxx format)

Body

application/json

inputs

object[]

required

Show child attributes

output_format

enum<string>

Available options:

mp4,

webm,

hls

Example:

"mp4"

callback_url

string

Example:

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

Response

200 - application/json

Compilation started

success

boolean

Example:

true

status

enum<string>

Available options:

processing,

done,

failed

Example:

"processing"

data

object

Show child attributes

Download Timeline Video Billing

⌘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

Create Timeline v2

Search Collections

Authorizations

Body

Response