Live Stream - Create New Live Stream

This guide will provide an overview of how to create live stream using generated token in previous step Authentication.

Body Params

Property Name	Type	Description
name	string	Name of your live stream.
record	boolean	Whether you are recording or not. true for record, false for not record. For more info you can follow Recording Guide.
restream [Optional]	Array	RTMP url and stream key from the provided platforms such as Youtube or Facebook. For more info you can follow Restream on Social Media.

cURL

curl -L -X POST 'https://api.videosdk.live/v1/livestreams' \
--header 'Authorization: `jwt token goes here`' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nickname for livestream",
    "record": true,
    "restream": [
      {
          "url": "rtmp://x.rtmp.youtube.com/live2",
          "streamKey": "0tjp-h6a2-8c9d-vusv-01uu"
      }
    ]
}'

NodeJS/JS

var fetch = require("node-fetch");

const url = "https://api.videosdk.live/v1/livestreams";
var options = {
  method: "POST",
  headers: {
    Authorization: `${YOUR_JWT_TOKEN}`,
    Accept: "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Nickname for livestream", record: true
    restream: [
      {
          "url": "rtmp://x.rtmp.youtube.com/live2",
          "streamKey": "0tjp-h6a2-8c9d-vusv-01uu"
      }
    ]
    }),
};

fetch(url, options)
  .then((res) => res.json())
  .then((json) => console.log(json))
  .catch((err) => console.error("error:" + err));

Python

import requests

url = "https://api.videosdk.live/v1/livestreams"

payload = {
  "name": "Nickname for livestream", "record": True,
  "restream": [
      {
          "url": "rtmp://x.rtmp.youtube.com/live2",
          "streamKey": "0tjp-h6a2-8c9d-vusv-01uu"
      }
    ]
}
headers = {
    "Authorization": `${YOUR_JWT_TOKEN}`,
    "Accept": "application/json",
    "Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.videosdk.live/v1/livestreams")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Content-Type"] = 'application/json'
request["Authorization"] = `${YOUR_JWT_TOKEN}`
request.body = "{\"record\":false,\"name\":\"Nickname for livestream\",\"restream\": [ { \"url\": \"rtmp://x.rtmp.youtube.com/live2\", \"streamKey\": \"0tjp-h6a2-8c9d-vusv-01uu\" } ]}"

response = http.request(request)
puts response.read_body

RESPONSE

{
  "record": false,
  "name": "videosdk",
  "streamKey": "eb175-5-4e5-60-aacfce300b",
  "streamUrl": "rtmp://live.videosdk.live/live/",
  "upstreamUrl": "rtmp://live.videosdk.live/live/...",
  "downstreamUrl": "https://live.videosdk.live/live/.../index.m3u8",
  "recordingUrl": "https://live.videosdk.live/live/.../storage/index.m3u8",
  "restream": [
    {
      "_id": "60e2fed0135c9810f490f3b6",
      "url": "rtmp://x.rtmp.youtube.com/live2",
      "streamKey": "0tjp-h6a2-8c9d-vusv-01uu"
    }
  ],
  "id": "60e2fe88135c9810f490f3b4"
}

• Response Body

  parameters

  • idstring

    Unique identifier of live stream.

  • namestring

    Provided name of the live stream.

  • recordboolean

    Flag for live stream recording, which you have provided while creating live stream.

  • streamKeystring

    Stream keys are like your live stream’s password and address.

  • streamUrlstring

    It's URL, without streamKey.

  • upstreamUrlstring

    where a RTMP stream is used to send video between an encoder and server.

  • downstreamUrlstring

    It's URL, Where you can play live stream in video player (Support HLS format).

  • recordingUrlstring

    It's URL, Where live stream recording is stored. NOTE: This property is only visible, if you set `record : true` in body params.

  • restreamarray

    This property contains object of RTMP url and streamKey, which you have provided in body params.