VIvideo-db
Capture

Start capture session

Changed on
post/capture/session/start

Request

Request body

session_idstring required
ws_connection_idstring
callback_urlstring

Example request

{
  "session_id": "capture-12345",
  "channels": [
    {
      "channel_id": "mic",
      "channel_name": "Microphone",
      "type": "audio",
      "store": true
    }
  ],
  "ws_connection_id": "conn-123",
  "callback_url": "https://webhook.example.com/callback"
}

Response

Capture session started

successboolean

Example response

{
  "success": true,
  "data": {
    "session_id": "capture-12345",
    "status": "starting"
  }
}

Changes