Skip to main content
PATCH
/
rtstream
/
{stream_id}
Update RTStream
curl --request PATCH \
  --url https://api.videodb.io/rtstream/{stream_id}/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "name": "Updated Stream Name",
  "sample_rate": 15
}
'
{
  "success": true,
  "data": {
    "id": "rts-12345",
    "name": "My Stream",
    "status": "connected",
    "sample_rate": 30,
    "media_types": [
      "video",
      "audio"
    ],
    "collection_id": "default",
    "store": false,
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.videodb.io/llms.txt

Use this file to discover all available pages before exploring further.

Update the configuration of an existing real-time stream, such as its name or sample rate.
  • Only provided fields are updated; omitted fields remain unchanged
  • Changes to sample_rate take effect immediately on the running stream

Authorizations

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

​
stream_id
string
required
Example:

"rts-12345"

Body

application/json
​
name
string
Example:

"Updated Stream Name"

​
sample_rate
integer
Example:

15

Response

RTStream updated

​
success
boolean
Example:

true

​
data
object