Describe Video Frame - VideoDB Documentation

Describe video frame

curl --request POST \
  --url https://api.videodb.io/video/{video_id}/frame/{frame_id}/describe/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "prompt": "Describe this frame",
  "model_name": "gpt-4-vision"
}
'

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({prompt: 'Describe this frame', model_name: 'gpt-4-vision'})
};

fetch('https://api.videodb.io/video/{video_id}/frame/{frame_id}/describe/', 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}/frame/{frame_id}/describe/",
  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([
    'prompt' => 'Describe this frame',
    'model_name' => 'gpt-4-vision'
  ]),
  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}/frame/{frame_id}/describe/"

	payload := strings.NewReader("{\n  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\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}/frame/{frame_id}/describe/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\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}/frame/{frame_id}/describe/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "prompt": "Describe this frame",
  "model_name": "gpt-4-vision"
}'

import Foundation

let parameters = [
  "prompt": "Describe this frame",
  "model_name": "gpt-4-vision"
] as [String : Any?]

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

let url = URL(string: "https://api.videodb.io/video/{video_id}/frame/{frame_id}/describe/")!
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}/frame/{frame_id}/describe/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\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}/frame/{frame_id}/describe/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\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({prompt: 'Describe this frame', model_name: 'gpt-4-vision'})
};

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

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  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\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}/frame/{frame_id}/describe/");

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  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\n}");

CURLcode ret = curl_easy_perform(hnd);

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\n}")
val request = Request.Builder()
  .url("https://api.videodb.io/video/{video_id}/frame/{frame_id}/describe/")
  .post(body)
  .addHeader("x-access-token", "<api-key>")
  .addHeader("Content-Type", "application/json")
  .build()

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

{
  "success": true,
  "data": {
    "description": "Frame description text"
  }
}

POST

video

{video_id}

frame

{frame_id}

describe

Describe video frame

curl --request POST \
  --url https://api.videodb.io/video/{video_id}/frame/{frame_id}/describe/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "prompt": "Describe this frame",
  "model_name": "gpt-4-vision"
}
'

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({prompt: 'Describe this frame', model_name: 'gpt-4-vision'})
};

fetch('https://api.videodb.io/video/{video_id}/frame/{frame_id}/describe/', 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}/frame/{frame_id}/describe/",
  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([
    'prompt' => 'Describe this frame',
    'model_name' => 'gpt-4-vision'
  ]),
  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}/frame/{frame_id}/describe/"

	payload := strings.NewReader("{\n  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\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}/frame/{frame_id}/describe/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\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}/frame/{frame_id}/describe/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "prompt": "Describe this frame",
  "model_name": "gpt-4-vision"
}'

import Foundation

let parameters = [
  "prompt": "Describe this frame",
  "model_name": "gpt-4-vision"
] as [String : Any?]

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

let url = URL(string: "https://api.videodb.io/video/{video_id}/frame/{frame_id}/describe/")!
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}/frame/{frame_id}/describe/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\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}/frame/{frame_id}/describe/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\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({prompt: 'Describe this frame', model_name: 'gpt-4-vision'})
};

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

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  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\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}/frame/{frame_id}/describe/");

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  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\n}");

CURLcode ret = curl_easy_perform(hnd);

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"prompt\": \"Describe this frame\",\n  \"model_name\": \"gpt-4-vision\"\n}")
val request = Request.Builder()
  .url("https://api.videodb.io/video/{video_id}/frame/{frame_id}/describe/")
  .post(body)
  .addHeader("x-access-token", "<api-key>")
  .addHeader("Content-Type", "application/json")
  .build()

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

{
  "success": true,
  "data": {
    "description": "Frame description text"
  }
}

Generate an AI-powered description of a specific video frame’s visual content.

import videodb

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

# Get scene collection
scene_collection = video.get_scene_collection("scene_collection_id")

# Get a frame from a scene
scene = scene_collection.scenes[0]
frame = scene.frames[0]

# Describe the frame
description = frame.describe()

print(f"Frame description: {description}")
print(f"Frame time: {frame.frame_time}s")

# Describe with custom prompt
custom_desc = frame.describe(prompt="List all objects visible")

# Describe with custom model configuration
description = frame.describe(
    prompt="Describe this frame in detail",
    model_name="pro",
    model_config={"temperature": 0.5}
)

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

// Get scene collection
const sceneCollection = await video.getSceneCollection('scene_collection_id');

// Get a frame from a scene
const scene = sceneCollection.scenes[0];
const frame = scene.frames[0];

// Describe the frame
const description = await frame.describe();

console.log(`Frame description: ${description}`);
console.log(`Frame time: ${frame.frameTime}s`);

// Describe with custom prompt
const customDesc = await frame.describe('List all objects visible');

// Describe with custom model configuration
const detailed = await frame.describe(
    'Describe this frame in detail',
    'pro',
    { temperature: 0.5 }
);

Generates detailed visual description using AI vision models
Can use custom prompts to focus description on specific aspects
Pass model_name separately from model_config
Overwrites existing frame description
Frame IDs start with fr- prefix
Each frame includes timestamp (frame_time) in the video
Useful for generating captions or accessibility descriptions

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"

frame_id

string

required

Example:

"frame-123"

Body

application/json

prompt

string

Example:

"Describe this frame"

model_name

string

Example:

"gpt-4-vision"

Response

200 - application/json

Frame description generated

success

boolean

Example:

true

data

object

Show child attributes