Skip to main content
POST
Start capture session
Start a previously created capture session with specific channel configurations. Define the audio and video channels to capture.
  • session_id and channels are required
  • Each channel needs a channel_id and can be of type audio or video
  • Set store to true to persist captured media in VideoDB
  • Use callback_url for webhook notifications on session events

Get Streaming Session

Get RTSP URLs for the session

Stop Session

Stop the capture session

Authorizations

x-access-token
string
header
required

API key for authentication (sk-xxx format)

Body

application/json
session_id
string
required
Example:

"capture-12345"

channels
object[]
required
ws_connection_id
string
Example:

"conn-123"

callback_url
string
Example:

"https://webhook.example.com/callback"

Response

Capture session started

success
boolean
Example:

true

data
object