Get Video Summary
curl --request GET \
--url https://api.bota.dev/v1/video-summaries/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.bota.dev/v1/video-summaries/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.bota.dev/v1/video-summaries/{id}', 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.bota.dev/v1/video-summaries/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.bota.dev/v1/video-summaries/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.bota.dev/v1/video-summaries/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bota.dev/v1/video-summaries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "vs_abc123",
"recording_id": "rec_abc123",
"status": "completed",
"keyframes": [
{
"media_id": "med_005",
"timestamp_ms": 15000,
"caption": "Presenter shows architecture diagram on whiteboard with three-tier layout",
"transcript_context": "At 0:15 — 'So here's our proposed architecture...'",
"relevance_score": 0.95
},
{
"media_id": "med_005",
"timestamp_ms": 82000,
"caption": "Close-up of database schema drawn on whiteboard",
"transcript_context": "At 1:22 — 'The key tables are users, devices, and recordings'",
"relevance_score": 0.88
},
{
"media_id": "med_009",
"timestamp_ms": 5000,
"caption": "Team gathered around table reviewing printed report",
"transcript_context": "At 3:45 — 'Let's look at last quarter's numbers'",
"relevance_score": 0.82
}
],
"overview": "15-minute walkthrough of proposed system architecture, covering API gateway, worker queues, and database schema. Ends with quarterly review discussion.",
"media_count": 3,
"created_at": "2025-01-15T11:00:00Z",
"completed_at": "2025-01-15T11:01:30Z"
}
{
"id": "vs_abc123",
"recording_id": "rec_abc123",
"status": "pending",
"keyframes": null,
"overview": null,
"media_count": 3,
"created_at": "2025-01-15T11:00:00Z",
"completed_at": null
}
Multi-Modal AI (Coming Soon)
Get Video Summary
Retrieve a video summary result
GET
/
video-summaries
/
{id}
Get Video Summary
curl --request GET \
--url https://api.bota.dev/v1/video-summaries/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.bota.dev/v1/video-summaries/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.bota.dev/v1/video-summaries/{id}', 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.bota.dev/v1/video-summaries/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.bota.dev/v1/video-summaries/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.bota.dev/v1/video-summaries/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bota.dev/v1/video-summaries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "vs_abc123",
"recording_id": "rec_abc123",
"status": "completed",
"keyframes": [
{
"media_id": "med_005",
"timestamp_ms": 15000,
"caption": "Presenter shows architecture diagram on whiteboard with three-tier layout",
"transcript_context": "At 0:15 — 'So here's our proposed architecture...'",
"relevance_score": 0.95
},
{
"media_id": "med_005",
"timestamp_ms": 82000,
"caption": "Close-up of database schema drawn on whiteboard",
"transcript_context": "At 1:22 — 'The key tables are users, devices, and recordings'",
"relevance_score": 0.88
},
{
"media_id": "med_009",
"timestamp_ms": 5000,
"caption": "Team gathered around table reviewing printed report",
"transcript_context": "At 3:45 — 'Let's look at last quarter's numbers'",
"relevance_score": 0.82
}
],
"overview": "15-minute walkthrough of proposed system architecture, covering API gateway, worker queues, and database schema. Ends with quarterly review discussion.",
"media_count": 3,
"created_at": "2025-01-15T11:00:00Z",
"completed_at": "2025-01-15T11:01:30Z"
}
{
"id": "vs_abc123",
"recording_id": "rec_abc123",
"status": "pending",
"keyframes": null,
"overview": null,
"media_count": 3,
"created_at": "2025-01-15T11:00:00Z",
"completed_at": null
}
This feature is Coming Soon and not yet available.
Overview
Retrieves a video summary by ID. Poll untilstatus is completed, or listen for the video_summary.completed webhook.
Authentication
Requires a valid API key withvideo_summaries:read scope.
Path Parameters
Video summary ID (e.g.,
vs_abc123)Response
{
"id": "vs_abc123",
"recording_id": "rec_abc123",
"status": "completed",
"keyframes": [
{
"media_id": "med_005",
"timestamp_ms": 15000,
"caption": "Presenter shows architecture diagram on whiteboard with three-tier layout",
"transcript_context": "At 0:15 — 'So here's our proposed architecture...'",
"relevance_score": 0.95
},
{
"media_id": "med_005",
"timestamp_ms": 82000,
"caption": "Close-up of database schema drawn on whiteboard",
"transcript_context": "At 1:22 — 'The key tables are users, devices, and recordings'",
"relevance_score": 0.88
},
{
"media_id": "med_009",
"timestamp_ms": 5000,
"caption": "Team gathered around table reviewing printed report",
"transcript_context": "At 3:45 — 'Let's look at last quarter's numbers'",
"relevance_score": 0.82
}
],
"overview": "15-minute walkthrough of proposed system architecture, covering API gateway, worker queues, and database schema. Ends with quarterly review discussion.",
"media_count": 3,
"created_at": "2025-01-15T11:00:00Z",
"completed_at": "2025-01-15T11:01:30Z"
}
{
"id": "vs_abc123",
"recording_id": "rec_abc123",
"status": "pending",
"keyframes": null,
"overview": null,
"media_count": 3,
"created_at": "2025-01-15T11:00:00Z",
"completed_at": null
}
Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Video summary identifier (vs_*) |
recording_id | string | Source recording (rec_*) |
status | string | pending, processing, completed, failed |
keyframes | array | null | Extracted key frames with captions (null until completed) |
keyframes[].media_id | string | Source video media (med_*) |
keyframes[].timestamp_ms | integer | Frame timestamp within the video in milliseconds |
keyframes[].caption | string | AI-generated description of the frame |
keyframes[].transcript_context | string | null | Correlated transcript segment |
keyframes[].relevance_score | number | Importance score (0–1) |
overview | string | null | Overall narrative summary of the video content |
media_count | integer | Number of video items processed |
created_at | string | Creation timestamp (ISO 8601) |
completed_at | string | null | Completion timestamp (ISO 8601) |
Webhooks
| Event | Description |
|---|---|
video_summary.completed | Video summary finished successfully |
video_summary.failed | Video summary encountered an error |
Was this page helpful?
⌘I

