Skip to main content
POST
Python

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Body

application/json
restream
object
Example:

Response

Successful

name
string

Restream name

live
boolean

Indicates that the stream is being published. Has two possible values:

  • true — stream is being published
  • false — stream isn't published
active
boolean

Enables/Disables restream. Has two possible values:

  • true — restream is enabled and can be started

  • false — restream is disabled.

Default is true

uri
string

A URL to push the stream to. Supported protocols: rtmp, rtmps, srt. For SRT target URLs, only mode=caller is supported.

Example:

"srt://example.com:1234?mode=caller"

stream_id
integer

ID of the stream to restream

client_user_id
integer

Custom field where you can specify user ID in your system

no_audio
boolean
default:false

Removes the source audio track from the restream. Has two possible values:

  • false – the source audio track is forwarded to the target as is (default)
  • true – the audio track is removed or replaced, depending on no_audio_mode

Useful to avoid copyright claims on platforms like YouTube when the source stream contains licensed music or other copyrighted audio.

Only strict boolean values (true/false) are accepted; any other value returns a 422 error.

no_audio_mode
enum<string>
default:drop

Defines how the audio track is handled when no_audio is true. Ignored when no_audio is false.

Types:

  • "drop" – removes the audio track entirely.
  • "silence" – replaces the audio track with a silent track instead of removing it.

Note: YouTube rejects incoming streams with no audio track at all. Use no_audio_mode=silence when restreaming to YouTube.

Available options:
drop,
silence
source
enum<string>
default:original

Selects which version of the stream is used as the source for the restream.

Types:

  • "original" – uses the original ingested stream without any modifications (default).
  • "transcoded" – uses the transcoded output, including overlays. Use it when you want to restream the stream with enabled overlays.

Note: For transcoded, the highest quality available in the stream's quality ladder is used. For example, if the ladder is 480p/720p/1080p, 1080p is used; if the ladder goes up to 4K, 4K is used.

Available options:
original,
transcoded
id
integer

Restream ID

client_id
integer

Client ID

playlist_id
integer | null

ID of the playlist used as source for the restream, if applicable

quality_id
integer | null

ID of the specific transcoded quality used as source for the restream, if applicable