Skip to content
Developers

Create an input

POST/v1/streams/inputs

POST
/v1/streams/inputs
curl --request POST \
  --url https://api.ligr.live/rest/v1/streams/inputs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "OB van 1", "latencyMs": 1000 }'

Creates an input. LIGR generates the host, the application name and the stream key. Send your picture to rtmpUrl with streamKey, or to srtUrl. A pull input reads sourceUrl instead.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

LIGR generates the host, the application name and the stream key.

object
name
required
string
type

Default default, a push endpoint.

string
Allowed values: default pull
sourceUrl

Required for a pull input. The RTMP or SRT URL LIGR pulls.

string
latencyMs

Receive latency in milliseconds. One of 20, 50, 100, 150, 250, 350, 500, 1000, 1500, 2000, 2500, 3000. Default 1000.

integer format: int32
Example
{
  "name": "OB van 1",
  "latencyMs": 1000
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json

An input of the organization. A default input is a push endpoint LIGR hosts: send RTMP to rtmpUrl with streamKey, or SRT to srtUrl. A pull input reads sourceUrl.

object
id
required

Entity identifier

integer format: int32
>= 1
name
required
string
type
required
string
Allowed values: default pull
host
required
string
applicationName
required
string
streamKey
required
string
rtmpUrl
required

RTMP ingest URL. Publish with streamKey as the stream key.

string
srtUrl
required

SRT ingest URL, stream id included.

string
sourceUrl
required

For a pull input: the URL LIGR pulls.

string
nullable
latencyMs
required

Receive latency in milliseconds.

number format: double
createdAt
required
string
updatedAt
required
string
Example
{
  "type": "default"
}

400

Section titled “400”

Request is invalid

Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

Api key provides insufficient access for the request

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

Input not found

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

429

Section titled “429”

Api key has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

500

Section titled “500”

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}