Skip to main content
POST
Create RTStream
Create a new real-time stream by connecting to an RTSP or YouTube stream URL. The stream begins processing immediately.
  • url is required and must be a valid RTSP or YouTube stream URL
  • sample_rate controls the frame sampling rate (default: 30)
  • media_types specifies which media to capture: video, audio, or both
  • Set store to true to persist stream recordings
  • Enable enable_transcript for automatic speech transcription

RTSP Ingest Guide

Learn about RTSP stream ingestion

Stream Lifecycle

Understand stream states

Authorizations

x-access-token
string
header
required

API key for authentication (sk-xxx format)

Body

application/json
url
string
required

RTSP or YouTube stream URL

Example:

"rtsp://example.com:8554/stream"

name
string
Example:

"My Stream"

collection_id
string
default:default
Example:

"default"

sample_rate
integer
default:30
Example:

30

media_types
enum<string>[]
Available options:
video,
audio
Example:
store
boolean
default:false
Example:

false

enable_transcript
boolean
default:true
Example:

true

ws_connection_id
string
Example:

"conn-123"

Response

RTStream created

success
boolean
Example:

true

data
object