Developer Portal
  1. Getting Started /
  2. Using Live Stream API /

Using Live Stream API

Learn how to use and integrate the live stream API into your application

Get an application key

To allow your app accessing the Live Stream API, you need an application key or you can call it API key instead. This application key is unique per application, and you will need to use it will all your API request. Follow these steps to create your application key:

  1. Register an Inlive account.
  2. Go to the integration page.
  3. Create an application key. Make sure you copy the key after you create it because you won’t be able to see it again later.

Use Live Stream API

After having your application key, you will need to use your application key as a bearer token to authenticate all your API requests. We use a standard HTTP REST API, so you can use any library to help you make an HTTP request like Axios, CURL, or just a simple fetch function.

REST API Endpoints

Check out our REST API Endpoint documentation to see all the available endpoints. We have a mix of HTTP methods and URL combinations to build our API endpoints, so you can use the same URL endpoint for different purposes depending on the HTTP method you use.

Inlive SDK

Use our SDK to simplify your development with live stream API. Currently our SDK only available in JavaScript. Let us know the platform that we must support for our SDK by requesting it through our Github Discussion.

With our SDK, going live is simple as this code below:

import {InliveStream, InliveApp} from '@inlivedev/inlive-js-sdk'

const app = InliveApp.init({apiKey:'<your-api-key>'})
const stream = await InliveStream.createStream(app,{name:'my first stream'})

const media = await

await stream.prepare()
await stream.init(

// {
//   "hls": "master.m8eu"
//   "dash":"manifest.mpd"
// }

In the viewer page, you can get the video manifests with this:

import {InliveStream, InliveApp} from '@inlivedev/inlive-js-sdk'

const app = InliveApp.init({apiKey:'<your-api-key>'})

const stream = await InliveStream.getStream(app,streamID)

// {
//   "hls": "master.m8eu"
//   "dash":"manifest.mpd"
// }

Check out our tutorial with SDK for more details.

API Authentication

You can use the application key as a bearer token for an authenticated request. Below is an example of making authenticated requests to get all the streams you have created with the same application key with Fetch API.

const request = await fetch('',{
    method: 'GET',
    mode: 'cors', // no-cors, *cors, same-origin,
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${applicationKey}` //your application key variable

const streams = await request.json();

Check other endpoints to know the HTTP method, body, or URL parameters used to make different API requests.

With our SDK, you only need to pass the application key to InliveApp.init() like this:

const app = InliveApp.init({apiKey: applicationKey}) //your application key variable
const stream = InliveStream.createStream(app,{name:'my first stream'})

Capture and stream the video

To create a live streaming video, the video need to be captured from the camera or you can also stream it from a file. Depend on your case. But once you get the video stream, you need to send the video stream to our server in order to process it and publish it as a live video streaming.

Check out our WebRTC tutorial to understand how to capture the video from your device camera and send it to our platform.

Play or embed the video

When you send the video source input through WebRTC protocol, the Inlive live stream encoder will start the live streaming, and you can play or embed the live video to your app. Inlive is producing a live video stream in two standard formats:

  • Low latency Dash(LL-Dash), with ~3 seconds playback latency
  • HLS with ~7 seconds playback latency.

We still working on the latency because it involve not only our side but also on the video player part. We’re working on a guideline how to achieve the target latency above.

You can choose which format you want to use if you’re using your own or an open-source video player. But if you use our embedded HTML player, the player will automatically use low latency Dash if your browser is supported but will fall back to HLS format if not.

Check the play video section in our complete tutorial on using Inlive APIs to get the video and play it in your app.