Create a live entity

To start live streaming, you need to create an Entity object. Once the request is received, Uiza will allocate resources to serve your live stream.

/v1/live-entities

POST https://api.uiza.io/api-live/owner/v1/live-entities

Request Body

Name	Type	Description
name	string	The entity's name.
description	string	An arbitrary string attached to the object. Often useful for displaying to users.
dvr	boolean	Indicates whether Digital Video Record (DVR) is enabled for the live_entity. Set as true to enable and as false to disable. The default value is false.
encoding_template	string	Indicates whether encoding mode is enabled for the live_entity. Set as sd, hd or fhd to enable and as none to disable.

200

{
  "data": {
    "id": "2b970a39-874a-4d2a-be8a-fd445646d74c",
    "name": "Test event without encoding",
    "description": "Event for Test",
    "region": "in-bangalore-1",
    "status": "init",
    "dvr": false,
    "encoding_template": "none",
    "ingest": null,
    "playback": null,
    "relay": [],
    "created_at": "2020-03-23T07:22:34Z",
    "updated_at": "2020-03-23T07:22:34Z"
  }
}

400

Missing name

{
  "message": "Your request is missing name parameter. Please, verify and resubmit.",
  "error_type": "invalid_request_error"
}

Missing region

{
  "message": "Your request is missing region parameter. Please, verify and resubmit.",
  "error_type": "invalid_request_error"
}

Invalid region

{
  "message": "The requested region is invalid. See the list of available regions here: docs.uiza.io/getting-started/regions.",
  "error_type": "invalid_request_error"
}

401

{
  "message": "You are unauthorized to access the requested resource. Please verify and resubmit.",
  "error_type": "invalid_request_error"
}5

500

{
  "message": "An unexpected error occurred on Uiza's end.",
  "error_type": "api_error"
}

Sample Request

curl --location --request POST 'https://api.uiza.io/api-live/owner/v1/live-entities' \
--header 'Authorization: <token>' \
--header 'uiza-app-id: <your_app_id>' \
--data-raw '{
    "name": "Test event with encoding",
    "description": "Event for Test",
    "encoding_template": "sd"
}'