Create Video Summary
curl --request POST \
--url https://api.bota.dev/v1/video-summaries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recording_id": "<string>",
"media_ids": [
"<string>"
],
"max_keyframes": 123,
"include_transcript_context": true
}
'import requests
url = "https://api.bota.dev/v1/video-summaries"
payload = {
"recording_id": "<string>",
"media_ids": ["<string>"],
"max_keyframes": 123,
"include_transcript_context": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recording_id: '<string>',
media_ids: ['<string>'],
max_keyframes: 123,
include_transcript_context: true
})
};
fetch('https://api.bota.dev/v1/video-summaries', 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",
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([
'recording_id' => '<string>',
'media_ids' => [
'<string>'
],
'max_keyframes' => 123,
'include_transcript_context' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.bota.dev/v1/video-summaries"
payload := strings.NewReader("{\n \"recording_id\": \"<string>\",\n \"media_ids\": [\n \"<string>\"\n ],\n \"max_keyframes\": 123,\n \"include_transcript_context\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.bota.dev/v1/video-summaries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recording_id\": \"<string>\",\n \"media_ids\": [\n \"<string>\"\n ],\n \"max_keyframes\": 123,\n \"include_transcript_context\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bota.dev/v1/video-summaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recording_id\": \"<string>\",\n \"media_ids\": [\n \"<string>\"\n ],\n \"max_keyframes\": 123,\n \"include_transcript_context\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "vs_abc123",
"recording_id": "rec_abc123",
"status": "pending",
"media_count": 3,
"created_at": "2025-01-15T11:00:00Z"
}
{
"error": {
"code": "validation_error",
"message": "Recording has no uploaded video media"
}
}
Multi-Modal AI (Coming Soon)
Create Video Summary
Generate a visual summary from video clips with key frames and captions
POST
/
video-summaries
Create Video Summary
curl --request POST \
--url https://api.bota.dev/v1/video-summaries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recording_id": "<string>",
"media_ids": [
"<string>"
],
"max_keyframes": 123,
"include_transcript_context": true
}
'import requests
url = "https://api.bota.dev/v1/video-summaries"
payload = {
"recording_id": "<string>",
"media_ids": ["<string>"],
"max_keyframes": 123,
"include_transcript_context": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recording_id: '<string>',
media_ids: ['<string>'],
max_keyframes: 123,
include_transcript_context: true
})
};
fetch('https://api.bota.dev/v1/video-summaries', 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",
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([
'recording_id' => '<string>',
'media_ids' => [
'<string>'
],
'max_keyframes' => 123,
'include_transcript_context' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.bota.dev/v1/video-summaries"
payload := strings.NewReader("{\n \"recording_id\": \"<string>\",\n \"media_ids\": [\n \"<string>\"\n ],\n \"max_keyframes\": 123,\n \"include_transcript_context\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.bota.dev/v1/video-summaries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recording_id\": \"<string>\",\n \"media_ids\": [\n \"<string>\"\n ],\n \"max_keyframes\": 123,\n \"include_transcript_context\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bota.dev/v1/video-summaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recording_id\": \"<string>\",\n \"media_ids\": [\n \"<string>\"\n ],\n \"max_keyframes\": 123,\n \"include_transcript_context\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "vs_abc123",
"recording_id": "rec_abc123",
"status": "pending",
"media_count": 3,
"created_at": "2025-01-15T11:00:00Z"
}
{
"error": {
"code": "validation_error",
"message": "Recording has no uploaded video media"
}
}
This feature is Coming Soon and not yet available.
Overview
Generates a visual summary from video media captured during a recording. The system identifies key frames, generates captions for each, and produces a timeline of visual highlights alongside the audio narrative. Useful for quickly reviewing long recordings — see the most important visual moments without watching the entire video.Authentication
Requires a valid API key withvideo_summaries:write scope.
Request Body
Recording ID with uploaded video media (
rec_*)Specific video media IDs to summarize. If omitted, all video media is processed.
Maximum number of key frames to extract per video. Default:
10.Whether to correlate key frames with transcript segments. Default:
true.Response
{
"id": "vs_abc123",
"recording_id": "rec_abc123",
"status": "pending",
"media_count": 3,
"created_at": "2025-01-15T11:00:00Z"
}
{
"error": {
"code": "validation_error",
"message": "Recording has no uploaded video media"
}
}
Was this page helpful?
⌘I

