Sign in

v5

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-0112516159.5 KB
RTStream

Create RTStream

post/rtstream/

Request body

urlstring required

RTSP or YouTube stream URL

namestring
collection_idstring
sample_rateinteger
media_typesstring[]
storeboolean
enable_transcriptboolean
ws_connection_idstring

Example request

{
  "url": "rtsp://example.com:8554/stream",
  "name": "My Stream",
  "collection_id": "default",
  "sample_rate": 30,
  "media_types": [
    "video",
    "audio"
  ],
  "enable_transcript": true,
  "ws_connection_id": "conn-123"
}

Response

RTStream created

successboolean

Example response

{
  "success": true,
  "data": {
    "id": "rts-12345",
    "name": "My Stream",
    "status": "connected",
    "sample_rate": 30,
    "media_types": [
      "video",
      "audio"
    ],
    "collection_id": "default"
  }
}