Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

VideoDB Documentation home page

Get API Key
Get API Key

Documentation

Examples & Tutorials

Research Lab

Community & Resources

API Reference

Overview

API Reference

Authentication

Authentication
POST
Create API Key
GET
List API Keys
GET
Get User Info
DEL
Delete API Key
PUT
Set API Key Collections

Collections

Collections
POST
Create Collection
GET
List Collections
GET
Get Collection
PATCH
Update Collection
DEL
Delete Collection
POST
Upload to Collection
POST
Legacy Collection Search
GET
Get Upload URL
GET
Get WebSocket URL
POST
Search by Title
POST
Web Search

Videos

Videos
GET
List Videos
GET
Get Video Details
DEL
Delete Video
DEL
Delete Video Storage
PATCH
Update Video

Streaming & Playback

Streaming & Playback
POST
Create Custom Thumbnail
GET
List Video Thumbnails
GET
Get Video Thumbnail
POST
Generate Video Stream

Transcription

Transcription
POST
Create Video Transcription
GET
Get Video Transcription

Search V2 & Ask

Search V2 & Ask
High-level Search & DeepSearch
Semantic Search
Query
Aggregate
Ask
Legacy Search

Legacy Video Indexing & Search

Indexing & Search
POST
Create Spoken Word Index
GET
Get Video Index
POST
Create Scene Index
GET
List Scene Indexes
GET
Get Scene Index Details
DEL
Delete Scene Index
POST
Search Video
POST
Delete Video Index

Scene & Frame Analysis

Scene & Frame Analysis
POST
Extract Video Scenes
GET
Get Video Scenes
POST
Describe Video Scene
POST
Describe Video Frame
GET
Get Scene Collection
PATCH
Update Scene Collection
DEL
Delete Scene Collection

Advanced Operations

Advanced Operations
POST
Create Video Clip
POST
Execute Video Workflow
POST
Reframe Video
GET
Get Reframe Status

Audio

Audio
GET
List All Audio Files
GET
Get Audio Details
DEL
Delete Audio File
POST
Generate Audio URL
PATCH
Update Audio
POST
Create Audio Transcription
GET
Get Audio Transcription

Images

Images
GET
List All Images
GET
Get Image Details
DEL
Delete Image
POST
Generate Image URL
PATCH
Update Image

AI Generation

AI Generation
POST
Generate Image with AI
POST
Generate Video with AI
POST
Generate Audio with AI
POST
Generate Text with AI
POST
Dub Video
POST
Translate Video

Sandbox

POST
Create Sandbox
GET
List Sandboxes
GET
Get Sandbox
POST
Stop Sandbox
GET
Get Job

Timeline & Compilation

Timeline & Compilation
POST
Create Timeline (v1)
POST
Create Timeline (v2)
POST
Download Timeline Video
POST
Compile Search Results

Billing

Billing
GET
List Checkout Sessions
GET
Get Usage Statistics
GET
List Invoices
GET
Get Auto-Recharge Settings
POST
Configure Auto-Recharge
POST
Create Checkout Session
POST
Manual Credit Top-up

Downloads

Downloads
POST
Create Download Job
GET
List Download Jobs
GET
Get Download Status
POST
Update Download Job
DEL
Delete Download Job

Utilities

Utilities
GET
API Health Check
GET
Get Async Response
POST
Chat Completions

Assets

Assets
GET
List Assets

Editor

Editor
POST
Compile Editor Timeline
POST
Download Editor Timeline

Transcode

Transcode
POST
Start Transcode
GET
Get Transcode Status

Meeting

Meeting
POST
Record Meeting
GET
Get Meeting
GET
Get Meeting by Video

Capture

Capture
POST
Create Capture Session
GET
List Capture Sessions
GET
Get Capture Session
POST
Create Session Token
POST
Start Capture Session
GET
Get Streaming Session
POST
Stop Capture Session

RTStream

RTStream
GET
List RTStreams
POST
Create RTStream
GET
Get RTStream
PATCH
Update RTStream
PATCH
Update RTStream Status
POST
Export RTStream
GET
Get RTStream Playback URL
POST
Search RTStream

RTStream Transcription

RTStream Transcription
GET
Get RTStream Transcription
POST
Manage RTStream Transcription
GET
Get RTStream Transcription Status

Legacy RTStream Scene Indexing

RTStream Scene Indexing
POST
Create RTStream Scene Index
GET
List RTStream Scene Indexes
GET
Get RTStream Scene Index
GET
Get RTStream Scene Records
PATCH
Update RTStream Scene Index
PATCH
Update RTStream Scene Index Status

RTStream Events

RTStream Events
POST
Create Event
GET
List Events

Legacy RTStream Alerts

POST
Create Alert
GET
List Alerts
PATCH
Update Alert Status

API Reference

GET
Get service information
GET
Get user information
GET
Get user API keys
POST
Create new API key
DEL
Delete API key
GET
Get user collections
POST
Create new collection
GET
Get collection details
DEL
Delete collection
PATCH
Update collection
POST
Upload media to collection
POST
Search within collection
GET
List videos
GET
Get video details
DEL
Delete video
DEL
Delete video storage
POST
Create video stream
GET
Get video thumbnail
POST
Generate custom thumbnail
GET
Get all video thumbnails
GET
Get video transcription
POST
Generate video transcription
GET
Get video index status
POST
Create video index
POST
Search within video
GET
Get video scenes
POST
Create video scenes
POST
Describe video scene
POST
Describe video frame
POST
Generate video clip
POST
Execute video workflow
GET
List audios
GET
Get audio details
DEL
Delete audio
POST
Generate audio stream URL
GET
List images
GET
Get image details
DEL
Delete image
POST
Generate image URL
POST
Generate image using AI
POST
Generate video using AI
POST
Generate audio using AI
GET
Get self-inference generation job status
POST
Generate text using AI
POST
Compile timeline
GET
Get billing usage information
POST
Create billing checkout session
GET
Get billing checkout history
GET
Get billing invoices
POST
Create topup payment
GET
Get auto recharge settings
POST
Update auto recharge settings
GET
Get async operation result
GET
List download entries
POST
Create download request
DEL
Delete download entry
GET
Get download status/details
POST
Retry download
POST
OpenAI-compatible chat completions proxy
POST
Compile timeline (v2)
POST
Download compiled timeline
POST
Compile media content
GET
Get video scene index status
POST
Create video scene index
GET
Get scene index details
DEL
Delete scene index

Videos

PATCH
Update video
GET
Get scene collection details
DEL
Delete scene collection
PATCH
Update scene collection
POST
Delete video index
POST
Reframe video to different aspect ratio
GET
Get reframe job status

Audio

PATCH
Update audio
GET
Get audio transcription
POST
Generate audio transcription

Images

PATCH
Update image

Sandbox

GET
List Sandbox Compute pools
POST
Create a Sandbox Compute pool
GET
Get a Sandbox Compute pool
POST
Stop a Sandbox Compute pool

Collections

GET
Get presigned upload URL
GET
Get WebSocket connection URL

Search

POST
Search by title within collection
POST
Web search within collection

AI Generation

POST
Dub video with AI-generated audio
POST
Translate video content

Assets

GET
List all assets across collections

Authentication

PUT
Set API key collection scoping

Editor

POST
Compile editor timeline
POST
Download compiled editor timeline

Transcode

POST
Start transcode job
GET
Get transcode job status

Meeting

POST
Record a meeting
GET
Get meeting recording information
GET
Get meeting by video

Capture

GET
List capture sessions
POST
Create capture session
GET
Get capture session details
POST
Create capture session token
POST
Start capture session
GET
Get capture session with RTSP URLs
POST
Stop capture session

RTStream

GET
List RTStreams
POST
Create RTStream
GET
Get RTStream details
PATCH
Update RTStream
PATCH
Start or stop RTStream
POST
Export RTStream recording as VideoDB asset
GET
List RTStream scene indexes
POST
Create RTStream scene index
GET
Get RTStream scene index details
GET
Get RTStream scene records
PATCH
Update RTStream scene index prompt
PATCH
Update RTStream scene index status
POST
Search RTStream scene index
GET
Get RTStream playback URL
GET
Get RTStream transcription data
POST
Start or stop RTStream transcription
GET
Get RTStream transcription status
GET
List collection events
POST
Create collection event
GET
List RTStream alerts
POST
Create RTStream alert
PATCH
Update RTStream alert status

Endpoints

RTStream Events

RTStream Events

Define detection events for live streams

Define reusable detection-event templates for real-time stream monitoring.

Endpoints

Create Event

Define a detection event

List Events

Get all events

Update RTStream Scene Index Status

Create Event

x github linkedin discord

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform

Assistant

Responses are generated using AI and may contain mistakes.

Assistant

Responses are generated using AI and may contain mistakes.

​Endpoints

Create Event

List Events

Endpoints