Update a Stream

PATCH

stream

{stream_id}

Update Stream

curl --request PATCH \
  --url https://client.camb.ai/apis/stream/{stream_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "pipeline_patches": [
    {
      "pipeline_id": "spanish",
      "dubbing_enabled": false
    }
  ]
}
'

import requests

url = "https://client.camb.ai/apis/stream/{stream_id}"

payload = { "pipeline_patches": [
        {
            "pipeline_id": "spanish",
            "dubbing_enabled": False
        }
    ] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({pipeline_patches: [{pipeline_id: 'spanish', dubbing_enabled: false}]})
};

fetch('https://client.camb.ai/apis/stream/{stream_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://client.camb.ai/apis/stream/{stream_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'pipeline_patches' => [
        [
                'pipeline_id' => 'spanish',
                'dubbing_enabled' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Overview

Partially updates an existing stream. Send only the fields you want to change. Updates are allowed while the stream is scheduled, setting up, or started. There are two kinds of changes:

Configuration updates - rescheduling, replacing voices or dictionaries, and adding or modifying audio selections, profiles, pipelines, and targets. These are persisted into the stream configuration.
Live pipeline patches (pipeline_patches) - runtime-only adjustments to a running stream: turn dubbing on or off, adjust the dubbing mix, or nudge audio/video sync. These take effect within seconds and are not persisted.

List fields that carry ids (audio_selections, processing_profiles, encoding_profiles, pipelines, target_streams) are merged by id: entries you send are added or replaced as a whole, and existing entries are never removed.

You can paste a full JSON body into the Try it form and the fields fill in automatically - copy any example below as a starting point.

Turning dubbing on and off

Set dubbing_enabled on a pipeline patch. With false, dubbing pauses and the original audio passes through; with true, dubbing resumes.

curl -X PATCH "https://client.camb.ai/apis/stream/1234" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline_patches": [
      { "pipeline_id": "spanish", "dubbing_enabled": false }
    ]
  }'

import requests

payload = {
    "start_time": "2026-08-01T11:00:00Z",
    "end_time": "2026-08-01T13:00:00Z",
    "timezone": "UTC",
}

response = requests.patch(
    "https://client.camb.ai/apis/stream/1234",
    headers={"x-api-key": "YOUR_API_KEY"},
    json=payload,
)

response.raise_for_status()
print(response.json())

import requests

payload = {
    "pipeline_patches": [
        {
            "pipeline_id": "spanish",
            "mixing": {
                "original_audio_gain": 0.1,
                "background_audio_gain": 0.8,
            },
        }
    ]
}

response = requests.patch(
    "https://client.camb.ai/apis/stream/1234",
    headers={"x-api-key": "YOUR_API_KEY"},
    json=payload,
)

response.raise_for_status()
print(response.json())

Common updates

Goal	Fields to send
Pause / resume dubbing	`pipeline_patches[].dubbing_enabled`
Adjust the dubbing mix live	`pipeline_patches[].mixing` gains (0.0–1.0)
Fix audio/video sync live	`pipeline_patches[].avsync.delay` (−2.0 to 2.0 s)
Reschedule	`start_time`, `end_time`, `timezone`
Change voices or dictionaries	`voices`, `dictionaries`
Add a target language	a new entry in `pipelines` (and its target)
Add or repoint an output	`target_streams` entry with the same `id` (replace) or a new `id` (add)

Errors

400 - The stream has already finished and can no longer be updated.
404 - No stream with this ID belongs to your team.
422 - Validation error: unknown pipeline_id, an id reference that doesn’t resolve, or times without a matching timezone.

Authorizations

x-api-key

string

header

required

The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.

Path Parameters

stream_id

integer

required

Identifier of the stream to update.

Body

application/json

Partial update of a stream. All fields are optional; omit anything you do not want to change. List fields carrying ids (audio_selections, processing_profiles, encoding_profiles, pipelines, target_streams) are merged by id: entries you send are added or replaced, existing entries are never removed.

name

string | null

New display name.

description

string | null

New description.

initial_delay

integer | null

New setup lead time in seconds.

Required range: x > 0

voices

integer[] | null

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

dictionaries

integer[] | null

Replacement list of dictionary IDs (up to 5).

Maximum array length: 5

start_time

string<date-time> | null

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

end_time

string<date-time> | null

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

timezone

string | null

IANA time zone the updated times are expressed in.

audio_selections

AudioSelection · object[] | null

Audio selections to add or replace (merged by id).

Hide child attributes

audio_selections.id

string

required

Your identifier for this selection, referenced by pipelines[].audio_selection.

audio_selections.source

string

required

Audio track selector. Accepts FFmpeg-style selectors (a:0, 1, eng, #0x1fe, i:301, optionally with a channel suffix like :ch0,1) or magic selectors ($first_audio, $second_audio, $last_audio). Use Probe a Source Stream to discover tracks.

audio_selections.source_language

integer

required

Language spoken on the selected track. If the audio mixes several languages, use the main one; multilingual input is handled automatically. Numeric language ID from GET /source-languages, e.g. 1 for English (US).

audio_selections.background

string | null

Optional selector (same syntax as source) for a clean background/music track. When set, it is used as the background bed for mixing instead of demixing the source.

processing_profiles

ProcessingProfile · object[] | null

Processing profiles to add or replace (merged by id).

Hide child attributes

processing_profiles.id

string

required

Your identifier for this profile, referenced by pipelines[].profile.

processing_profiles.demixing

enum<string>

default:none

Separate speech from background music/effects before transcription.

Available options:

none,

best_model,

fast_model

processing_profiles.transcribing

enum<string>

default:none

Speech-to-text on the selected audio.

Available options:

none,

best_model,

fast_model

processing_profiles.translating

enum<string>

default:none

Translate the transcript into each output language.

Available options:

none,

best_model,

fast_model

processing_profiles.revoicing

enum<string>

default:none

Synthesise dubbed speech in the output language.

Available options:

none,

best_model,

fast_model

processing_profiles.mixing

OverdubConfig · object | null

Optional mix gains for dubbed output. Requires revoicing to be enabled.

Hide child attributes

processing_profiles.mixing.original_audio_gain

number | null

Volume of the original speaker while dubbed audio plays (0.0-1.0).

Required range: 0 <= x <= 1

processing_profiles.mixing.background_audio_gain

number | null

Volume of background music/ambience during dubbed segments (0.0-1.0).

Required range: 0 <= x <= 1

processing_profiles.mixing.fallback_audio_gain

number | null

Volume of the original audio while nothing is being dubbed (0.0-1.0).

Required range: 0 <= x <= 1

processing_profiles.mixing.fade_time

number

default:1

Cross-fade duration in seconds when switching between original and dubbed audio (0-5).

Required range: 0 <= x <= 5

processing_profiles.scte35_dubbing_control

Scte35DubbingControl · object | null

Optional automatic dubbing toggling on SCTE-35 ad-break markers.

Hide child attributes

processing_profiles.scte35_dubbing_control.on_out_of_network_start

string | null

default:disabled

Dubbing state applied when an ad break starts.

processing_profiles.scte35_dubbing_control.on_out_of_network_end

string | null

default:enabled

Dubbing state applied when an ad break ends.

encoding_profiles

EncodingProfile · object[] | null

Encoding profiles to add or replace (merged by id).

Hide child attributes

encoding_profiles.id

string

required

Your identifier for this profile.

encoding_profiles.audio_codec

string | null

Audio codec, e.g. aac.

encoding_profiles.audio_bitrate

string | null

Audio bitrate, e.g. 192k.

encoding_profiles.audio_channel_layout

string | null

Channel layout, e.g. stereo.

encoding_profiles.video_codec

string | null

Video codec, e.g. h264.

encoding_profiles.video_bitrate

string | null

Video bitrate, e.g. 5M.

pipelines

ProcessingPipeline · object[] | null

Pipelines to add or replace (merged by id).

Hide child attributes

pipelines.id

string

required

Your identifier for this pipeline.

pipelines.profile

string

required

id of an entry in processing_profiles.

pipelines.audio_selection

string

required

id of an entry in audio_selections.

pipelines.outputs

PipelineOutput · object[]

required

Assets this pipeline produces. Output ids must be unique across all pipelines.

Minimum array length: 1

Hide child attributes

pipelines.outputs.id

string

required

Your identifier for the produced asset, referenced by target_streams[].inputs[].asset_id.

pipelines.outputs.kind

enum<string>

required

Type of asset to produce.

Available options:

audio,

subtitle,

video,

data

pipelines.outputs.language

integer | null

Language of the asset. Required for audio and subtitle outputs. Numeric language ID. Use GET /source-languages for valid source_language values and GET /target-languages for valid output language values. For example, 1 is English (US) and 54 is Spanish (Spain).

source_stream

SourceStream · object | null

Replacement source configuration.

Hide child attributes

source_stream.id

string

required

Your identifier for the source stream, e.g. main-feed.

source_stream.url

string

required

URL of the live source to ingest, e.g. srt://ingest.example.com:9000.

source_stream.category

enum<integer> | null

Content category of the source stream, used to tune processing.

Value	Category
`1`	News and information
`2`	Sports and entertainment
`3`	Business and professional
`4`	Education and training
`5`	Events and ceremonies
`6`	Government and official

Available options:

1,

2,

3,

4,

5,

6

source_stream.passphrase

string | null

SRT encryption passphrase for the source, if the source is encrypted (10-79 characters).

Required string length: 10 - 79

source_stream.streamid

string | null

SRT streamid to send when connecting to the source, if it requires one. Not the Camb.ai stream ID.

source_stream.latency

integer | null

SRT receive latency in milliseconds (20-8000). Higher values tolerate more network jitter at the cost of delay. Recommended: 2000 for typical internet links.

Required range: 20 <= x <= 8000

target_streams

TargetStream · object[] | null

Target streams to add or replace (merged by id).

Hide child attributes

target_streams.id

string

required

Your identifier for the target, e.g. youtube-es.

target_streams.type

enum<integer>

required

Output protocol/type.

Available options:

1,

2,

3,

4,

5,

6

target_streams.url

string | null

Destination URL to push to. Omit for SRT listener (6) and HLS recording (3) targets - their URLs are generated and returned in the create response and stream status.

target_streams.passthrough_policy

enum<string>

default:all

Which source tracks are forwarded alongside the listed inputs. With all (the default), source tracks not replaced by a pipeline output are forwarded automatically.

Available options:

all,

none

target_streams.inputs

TargetStreamInput · object[]

Tracks to include in this output. May be omitted when passthrough_policy is all or for auto-hosted target types.

Hide child attributes

target_streams.inputs.asset_id

string | null

id of a pipeline output to include.

target_streams.inputs.passthrough_selector

string | null

Selector (e.g. v:0, a:eng) for a source track to forward unprocessed.

target_streams.inputs.pid_policy

enum<string>

default:auto

How the MPEG-TS PID for this track is chosen.

Available options:

preserve,

auto,

explicit

target_streams.inputs.pid

integer | null

Explicit MPEG-TS PID (32-8190). Required when pid_policy is explicit, forbidden otherwise.

Required range: 32 <= x <= 8190

target_streams.inputs.encoding_policy

enum<string>

default:auto

How this track is encoded.

Available options:

preserve,

auto,

explicit

target_streams.inputs.encoding_profile

string | null

id of an entry in encoding_profiles. Required when encoding_policy is explicit, forbidden otherwise.

target_streams.passphrase

string | null

SRT encryption passphrase to use when pushing to the destination.

target_streams.streamid

string | null

SRT streamid to send when connecting to the destination.

target_streams.constant_bitrate

MPEG-TS constant-bitrate control: false/omitted for variable bitrate, true to derive the mux rate from the source bandwidth, or an explicit rate string such as "500k" or "5M".

target_streams.latency

integer | null

SRT send latency in milliseconds (20-8000). Higher values tolerate more network jitter at the cost of delay. Recommended: 2000 for typical internet links.

Required range: 20 <= x <= 8000

pipeline_patches

PipelinePatch · object[] | null

Live, runtime-only adjustments to running pipelines: toggle dubbing, adjust the mix, or nudge A/V sync. Applied immediately and not persisted into the stream configuration.

Hide child attributes

pipeline_patches.pipeline_id

string

required

id of the pipeline to adjust.

pipeline_patches.dubbing_enabled

boolean | null

Turn live dubbing on or off for this pipeline. false pauses dubbing and passes the original audio through; true resumes it. Takes effect within a few seconds.

pipeline_patches.mixing

OverdubConfig · object | null

Live adjustment of the dubbing mix gains.

Hide child attributes

pipeline_patches.mixing.original_audio_gain

number | null

Volume of the original speaker while dubbed audio plays (0.0-1.0).

Required range: 0 <= x <= 1

pipeline_patches.mixing.background_audio_gain

number | null

Volume of background music/ambience during dubbed segments (0.0-1.0).

Required range: 0 <= x <= 1

pipeline_patches.mixing.fallback_audio_gain

number | null

Volume of the original audio while nothing is being dubbed (0.0-1.0).

Required range: 0 <= x <= 1

pipeline_patches.mixing.fade_time

number

default:1

Cross-fade duration in seconds when switching between original and dubbed audio (0-5).

Required range: 0 <= x <= 5

pipeline_patches.avsync

AVSyncConfig · object | null

Live audio/video sync adjustment.

Hide child attributes

pipeline_patches.avsync.delay

number | null

Audio/video sync adjustment in seconds (-2.0 to 2.0). Positive values delay audio. Unset by default (no adjustment).

Required range: -2 <= x <= 2

Response

Successful Response

The response is of type Response Patch Stream Data Stream Stream Id Patch · object.

Last modified on July 24, 2026

Delete a StreamDelete a stream, stopping it if it is live.

Update Stream

curl --request PATCH \
  --url https://client.camb.ai/apis/stream/{stream_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "pipeline_patches": [
    {
      "pipeline_id": "spanish",
      "dubbing_enabled": false
    }
  ]
}
'

import requests

url = "https://client.camb.ai/apis/stream/{stream_id}"

payload = { "pipeline_patches": [
        {
            "pipeline_id": "spanish",
            "dubbing_enabled": False
        }
    ] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({pipeline_patches: [{pipeline_id: 'spanish', dubbing_enabled: false}]})
};

fetch('https://client.camb.ai/apis/stream/{stream_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://client.camb.ai/apis/stream/{stream_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'pipeline_patches' => [
        [
                'pipeline_id' => 'spanish',
                'dubbing_enabled' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Getting Started

Models

Tutorials

SDK Guides

Hosting Platforms

Integrations

API Reference

Other Products

Release Logs

Update a Stream

Overview

Turning dubbing on and off

Common updates

Errors

Authorizations

Path Parameters

Body

Response

​Overview

​Turning dubbing on and off

​Common updates

​Errors

​Related endpoints

Authorizations

Path Parameters

Body

Response

Overview

Turning dubbing on and off

Common updates

Errors

Related endpoints