CAcamb
Apis
Streaming

Update Stream

Update a stream's configuration (merged by id, never removing existing entries) and apply live runtime adjustments such as toggling dubbing on or off. Allowed while the stream is scheduled, setting up, or started.

patch/stream/{stream_id}

Request

  • Base URL
    https://client.camb.ai/apis
  • URL
    https://client.camb.ai/apis/stream/{stream_id}
  • Auth
    API key in header x-api-key

Path parameters

stream_idinteger required

Identifier of the stream to update.

Request body

namestring nullable

New display name.

descriptionstring nullable

New description.

initial_delayinteger nullable

New setup lead time in seconds.

voicesinteger[] nullable

Replacement list of voice IDs. Empty means voices are cloned from the source speakers.

dictionariesinteger[] nullable

Replacement list of dictionary IDs (up to 5).

start_timestring date-time nullable

New scheduled start (ISO 8601 with UTC offset). Requires timezone.

end_timestring date-time nullable

New scheduled end (ISO 8601 with UTC offset). Requires timezone.

timezonestring nullable

IANA time zone the updated times are expressed in.

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.