Describe video scene
curl --request POST \
--url https://api.videodb.io/video/{video_id}/scene/{scene_id}/describe/ \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"prompt": "Describe what happens in this scene",
"model_name": "gpt-4"
}
'const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({prompt: 'Describe what happens in this scene', model_name: 'gpt-4'})
};
fetch('https://api.videodb.io/video/{video_id}/scene/{scene_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}/scene/{scene_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 what happens in this scene',
'model_name' => '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}/scene/{scene_id}/describe/"
payload := strings.NewReader("{\n \"prompt\": \"Describe what happens in this scene\",\n \"model_name\": \"gpt-4\"\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}/scene/{scene_id}/describe/")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"Describe what happens in this scene\",\n \"model_name\": \"gpt-4\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.videodb.io/video/{video_id}/scene/{scene_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 what happens in this scene\",\n \"model_name\": \"gpt-4\"\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}/scene/{scene_id}/describe/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"prompt": "Describe what happens in this scene",
"model_name": "gpt-4"
}'import Foundation
let parameters = [
"prompt": "Describe what happens in this scene",
"model_name": "gpt-4"
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://api.videodb.io/video/{video_id}/scene/{scene_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}/scene/{scene_id}/describe/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n \"prompt\": \"Describe what happens in this scene\",\n \"model_name\": \"gpt-4\"\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}/scene/{scene_id}/describe/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n \"prompt\": \"Describe what happens in this scene\",\n \"model_name\": \"gpt-4\"\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 what happens in this scene', model_name: 'gpt-4'})
};
fetch('https://api.videodb.io/video/{video_id}/scene/{scene_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}/scene/{scene_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 what happens in this scene\",\n \"model_name\": \"gpt-4\"\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}/scene/{scene_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 what happens in this scene\",\n \"model_name\": \"gpt-4\"\n}");
CURLcode ret = curl_easy_perform(hnd);val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"prompt\": \"Describe what happens in this scene\",\n \"model_name\": \"gpt-4\"\n}")
val request = Request.Builder()
.url("https://api.videodb.io/video/{video_id}/scene/{scene_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": "Scene description text"
}
}Describe Video Scene
Generate AI description of a video scene
POST
/
video
/
{video_id}
/
scene
/
{scene_id}
/
describe
/
Describe video scene
curl --request POST \
--url https://api.videodb.io/video/{video_id}/scene/{scene_id}/describe/ \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"prompt": "Describe what happens in this scene",
"model_name": "gpt-4"
}
'const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({prompt: 'Describe what happens in this scene', model_name: 'gpt-4'})
};
fetch('https://api.videodb.io/video/{video_id}/scene/{scene_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}/scene/{scene_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 what happens in this scene',
'model_name' => '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}/scene/{scene_id}/describe/"
payload := strings.NewReader("{\n \"prompt\": \"Describe what happens in this scene\",\n \"model_name\": \"gpt-4\"\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}/scene/{scene_id}/describe/")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"Describe what happens in this scene\",\n \"model_name\": \"gpt-4\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.videodb.io/video/{video_id}/scene/{scene_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 what happens in this scene\",\n \"model_name\": \"gpt-4\"\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}/scene/{scene_id}/describe/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"prompt": "Describe what happens in this scene",
"model_name": "gpt-4"
}'import Foundation
let parameters = [
"prompt": "Describe what happens in this scene",
"model_name": "gpt-4"
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://api.videodb.io/video/{video_id}/scene/{scene_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}/scene/{scene_id}/describe/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n \"prompt\": \"Describe what happens in this scene\",\n \"model_name\": \"gpt-4\"\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}/scene/{scene_id}/describe/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n \"prompt\": \"Describe what happens in this scene\",\n \"model_name\": \"gpt-4\"\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 what happens in this scene', model_name: 'gpt-4'})
};
fetch('https://api.videodb.io/video/{video_id}/scene/{scene_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}/scene/{scene_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 what happens in this scene\",\n \"model_name\": \"gpt-4\"\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}/scene/{scene_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 what happens in this scene\",\n \"model_name\": \"gpt-4\"\n}");
CURLcode ret = curl_easy_perform(hnd);val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"prompt\": \"Describe what happens in this scene\",\n \"model_name\": \"gpt-4\"\n}")
val request = Request.Builder()
.url("https://api.videodb.io/video/{video_id}/scene/{scene_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": "Scene description text"
}
}Generate an AI-powered description of a video scene’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")
# Describe a specific scene
scene = scene_collection.scenes[0]
description = scene.describe()
print(f"Scene description: {description}")
# Describe with custom prompt
custom_desc = scene.describe(prompt="Focus on people and their actions")
# Describe with custom model configuration
description = scene.describe(
prompt="Describe this scene in detail",
model_config={"model_name": "pro", "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');
// Describe a specific scene
const scene = sceneCollection.scenes[0];
const description = await scene.describe();
console.log(`Scene description: ${description}`);
// Describe with custom prompt
const customDesc = await scene.describe({ prompt: 'Focus on people and their actions' });
// Describe with custom model configuration
const detailed = await scene.describe({
prompt: 'Describe this scene in detail',
modelConfig: { modelName: 'pro', temperature: 0.5 }
});
- Generates description using AI vision models
- Can use custom prompts to guide description focus
- Optional
model_configdict acceptsmodel_name(e.g.,"pro") andtemperature(0.0-1.0) to control the vision model - Overwrites existing scene description
- Requires scene to be part of extracted scene collection
- Scene IDs start with
sc-prefix
Authorizations
API key for authentication (sk-xxx format)
Path Parameters
Pattern:
^m-Example:
"m-12345"
Example:
"scene-123"
Body
application/json
⌘I