Restreams

Create and start a restream

POST

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

Restreams the station to an external platform and starts it right away: the station's audio over a looped video background. Needs the platform's server URL and stream key (YouTube Studio, Twitch Creator Dashboard, Kick dashboard, Facebook Live Producer, VK Video Live, Rutube Studio, Telegram "stream with other apps"). Check its state with GET /v1/stream/{stream_id}/restreams a minute later: a wrong key shows as error_code target_rejected.

Path parameters

Name	Type	Description
stream_idRequired	string	Stream ID

Request body

Restream settings; stream_key is required

Name	Type	Description
background_id	string	BackgroundID is the looped video background (GET /v1/restream-backgrounds); omit for none.
platformRequired	string	Platform: youtube, twitch, kick, facebook, vklive, rutube, telegram or custom (any RTMP/RTMPS server).
resolution	string	Resolution of the background: 720, 1080, 2k or 4k, one the background offers; capped by the plan.
server_urlRequired	string	ServerURL is the platform's RTMP/RTMPS ingest URL, e.g. rtmp://a.rtmp.youtube.com/live2.
stream_key	string	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.

Name	Type	Description
message	string	Message contains human readable error details.
success	boolean	Success is always false for error payloads.

Name	Type	Description
message	string	Message contains human readable error details.
success	boolean	Success is always false for error payloads.

Name	Type	Description
message	string	Message contains human readable error details.
success	boolean	Success is always false for error payloads.

Name	Type	Description
message	string	Message contains human readable error details.
success	boolean	Success is always false for error payloads.