Uiza Documentation
2021-09-21
2021-09-21
  • Hola! 👋
  • Getting Started
    • Introduction
    • Authentication
    • Errors
    • Quick Starts
      • Live Streaming
      • Video Streaming
    • Pagination
    • Recommended Specifications
    • Sample Streaming Apps
      • NodeJS Live Streaming App
      • Java Live Streaming App
      • Python Live Streaming App
      • How to integrate live streaming into an Android App using Uiza’s Live API
    • Versioning
  • API Reference
    • Live Entities
      • Create a live entity
      • Retrieve a live entity
      • Update a live entity
      • Delete a live entity
      • List all live entities
      • Create a live relay
      • Update a live relay
      • Delete a live relay
    • Video Entities
      • Create a video entity
      • Retrieve a video entity
      • Update a video entity
      • Delete a video entity
      • List all video entities
    • Events
      • Event Types
    • Webhook Endpoints
      • Verifying signatures
      • Create a webhook endpoint
      • Update a webhook endpoint
      • Get a webhook endpoint
      • List all webhook endpoint
  • SDK REFERENCE
    • Introduction
    • Android SDK
      • Android Player SDK
      • Android Broadcast SDK
    • iOS SDK
      • iOS Player SDK
      • iOS Broadcast SDK
    • Web Player SDK
    • Flutter SDK
  • API UPGRADES
    • Release Notes
    • API Changelog
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Video Entities

Create a video entity

To create your video streaming, you need to create an Entity object.

/v1/video-entities

POST https://api.uiza.io/api-vod/owner/v1/video-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.

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.

{
  "data": {
    "id": "2b970a39-874a-4d2a-be8a-fd445646d74c",
    "name": "My video 1",
    "description": "Oops",
    "input_url": "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4",
    "encoding_template": "hd",
    "content_policy": "public",
    "status": "processing",
    "playback": null,
    "created_at": "2020-03-23T07:22:34Z",
    "updated_at": "2020-03-23T07:22:34Z"
  }
}
{
  "message": "Your request is missing name parameter. Please, verify and resubmit.",
  "error_type": "invalid_request_error"
}
{
  "message": "You are unauthorized to access the requested resource. Please verify and resubmit.",
  "error_type": "invalid_request_error"
}5
{
  "message": "An unexpected error occurred on Uiza's end.",
  "error_type": "api_error"
}
Sample Request
curl --location --request POST 'https://api.uiza.io/api-vod/owner/v1/video-entities' \
--header 'Authorization: <token>' \
--header 'uiza-app-id: <your_app_id>' \
--data-raw '{
    "name": "My video 1",
    "input_url": "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4",
    "encoding_template": "hd"
}'
PreviousVideo EntitiesNextRetrieve a video entity

Last updated 3 years ago

Was this helpful?