# Video Entities

A **`video_entity`** is created every time a video is uploaded to Uiza via a URL which redirects Uiza to your video storage to retrieve the video file. This URL could be either a *direct HTTP/HTTPS* link or a URL that leads to your *FTP or S3 storage*. 

Once the video has been successfully retrieved, Uiza transcodes the file into several renditions that have different resolutions and are compatible to different streaming protocol such as *HLS, fMP4*... These renditions are made available to your viewers by you publishing them to Uiza's *Content Delivery Network (CDN)* via Uiza APIs.

The APIs allow you to create, delete, publish, update the information of the video\_entities and retrieve your entities individually or collectively.

### The video entity object

#### Attributes

> **`id`** *string*
>
> The unique identifier for the video entity.

> **`name`** *string*
>
> The name of your video entity.

> **`description`** *string*
>
> Describes the content of the video entity. Often useful for displaying to viewers.

> **`short_description`** *string*
>
> A shortened version of your `description`.

> **`view`** *number*
>
> The number of times that the video has been viewed.

> **`poster`** *string*
>
> The URL of the video entity's poster image.

> **`thumbnail`** *string*
>
> The URL of the video entity's thumbnail image.

> **`input_type`** string
>
> It could be either `dvr` or `s3-uiza`. `dvr` indicates that your `video_entity` was created from a live record, and `s3-uiza` indicates it was created by a user uploading a VOD through the Uiza dashboard.

> **`duration`** *number*
>
> The duration of your video entity in seconds. It is measured up to one millionth of a second.

> **`publish_to_cdn`** *string*
>
> The status indicates whether your video entity had been published to Uiza's CDN or not. There are 4 possible statuses:
>
> > **`not-ready`** is returned when Uiza receives no request to publish the video entity yet.
> >
> > **`queue`** is returned when your video entity is in the queue to be published.
> >
> > **`success`** is returned when your video entity has been successfully published and your viewers are able to watch the video.
> >
> > **`failed`** is returned when something goes wrong during the publishing process of your video entity.

> **`playback`** *object*
>
> Contains the playback URL for different streaming protocols including HLS fMP4 (`hls`), HLS ts (`hls_ts`) and MPEG-dash (`mpd`). Use this URL to configure your player to play the video.

> **`created_at`** *string*
>
> The timestamp, at which the `video_entity` is created, follows the [ISO 8601 standard](https://www.w3.org/TR/NOTE-datetime-970915).

> **`updated_at`** *string*
>
> The timestamp, at which the most recent update to the `video_entity` occurred, follows the [ISO 8601 standard](https://www.w3.org/TR/NOTE-datetime-970915).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.uiza.io/api-reference/video-entities.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.