Skip to main content
PATCH
Start or stop RTStream
Start or stop a real-time stream. Use this to control the stream lifecycle without deleting it.
  • action must be start or stop
  • Stopping a stream pauses processing but retains its configuration
  • Restarting a stopped stream resumes from the live feed

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
action
enum<string>
required
Available options:
start,
stop
Example:

"stop"

Response

200 - application/json

RTStream status updated

success
boolean
Example:

true

message
string
Example:

"Operation successful"