Restreams

Change a restream

PATCH
https://api.tunio.ai/v1/stream/{stream_id}/restreams/{restream_id}

Saves new settings for a restream. A running restream restarts with them (restarted: true). Omit stream_key to keep the saved one.

Path parameters

NameTypeDescription
stream_idRequiredstringStream ID
restream_idRequiredstringRestream ID

Request body

Restream settings

NameTypeDescription
background_idstring
BackgroundID is the looped video background (GET /v1/restream-backgrounds); omit for none.
platformRequiredstring
Platform: youtube, twitch, kick, facebook, vklive, rutube, telegram or custom (any RTMP/RTMPS server).
resolutionstring
Resolution of the background: 720, 1080, 2k or 4k, one the background offers; capped by the plan.
server_urlRequiredstring
ServerURL is the platform's RTMP/RTMPS ingest URL, e.g. rtmp://a.rtmp.youtube.com/live2.
stream_keystring
StreamKey is the platform's stream key. Required to create; omit on update to keep the saved one.
Request example
01{
02 "background_id": "string",
03 "platform": "youtube",
04 "resolution": "1080",
05 "server_url": "rtmp://a.rtmp.youtube.com/live2",
06 "stream_key": "string"
07}

Responses

No schema details were provided for this payload.

NameTypeDescription
messagestring
Message contains human readable error details.
successboolean
Success is always false for error payloads.
NameTypeDescription
messagestring
Message contains human readable error details.
successboolean
Success is always false for error payloads.
NameTypeDescription
messagestring
Message contains human readable error details.
successboolean
Success is always false for error payloads.
NameTypeDescription
messagestring
Message contains human readable error details.
successboolean
Success is always false for error payloads.