Videos

Create video object

This endpoint is used to programmatically create a video object.

The request body when create a video object will look like this:

{
  "description": "string",
  "is_public": true,
  "metadata": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "qualities": ["string"],
  "tags": ["string"],
  "title": "video's title"
}

Notice the title is required.

For example, this would be a simplified body for this request:

{
  "title": "video's title"
}

POSThttps://api.aiozstream.network/api/videos/create

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Body

title* Video's title

description Video's description

is_public Video public's status

metadata Video's pairs of key and value

tags Video's tags

qualitites Video's transcoded qualities (allow: 144p, 240p, 360p, 480p, 720p, 1080p, 1440p, 2160p)

Response

201: Created

curl --location https://api.aiozstream.network/api/videos \
--header 'Accept-Language: en-US,en;q=0.9' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--data '{
"title": "video'\''s title"
}'

List videos

This API will list all your videos.

POSThttps://api.aiozstream.network/api/videos

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Body

offset The number of records to skip before starting to return the results (default: 0)

limit The maximum number of records to return in a query (default: 25, max: 100)

sort_by The field or property to sort by (default: created_at, allow: created_at, updated_at, title, size)

order_by The way record should be arranged (default: desc, allow: asc,desc)

tags Video's tags (ex: music,mp4)

metadata Video's metadata (ex: {"genre":"rock"})

status Video's status (allow: new, transcoding, done, fail, deleted)

search The keyword to search in both the title and description fields

Response

200: OK

{
    "status": "success",
    "data": {
        "videos": [
            {
                "id": "video_id",
                "user_id": "user_id",
                "title": "video's title (required)",
                "description": "",
                "metadata": null,
                "tags": null,
                "qualities": [
                    {
                        "name": "360p",
                        "status": "done",
                        "type": "hls"
                    },
                    {
                        "name": "720p",
                        "status": "done",
                        "type": "hls"
                    },
                    {
                        "name": "1080p",
                        "status": "done",
                        "type": "hls"
                    }
                ],
                "subtitles": null,
                "chapters": null,
                "player_theme": null,
                "duration": 283.492426,
                "size": 63109470,
                "is_mp4": false,
                "is_public": true,
                "is_panoramic": false,
                "status": "done",
                "created_at": "created_at",
                "updated_at": "updated_at",
                "assets": {
                    "source_url": "https://api.aiozstream.network/api/videos/video_id/source",
                    "thumbnail_url": "https://api.aiozstream.network/api/videos/video_id/thumbnail?resolution=original",
                    "hls_url": "https://api.aiozstream.network/api/videos/video_id/m3u8",
                    "mp4_url": "https://api.aiozstream.network/api/videos/video_id/mp4",
                    "iframe": "\u003ciframe src=\"https://embed.aiozstream.network/vod/video_id\" width=\"100%\" height=\"100%\" frameborder=\"0\" scrolling=\"no\" allowfullscreen=\"true\"\u003e\u003c/iframe\u003e",
                    "player_url": "https://embed.aiozstream.network/vod/video_id"
                },
                "player_theme_id": ""
            }
        ],
        "total": 1
    }
}

curl 'https://api.aiozstream.network/api/videos' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'authorization: Bearer <YOUR_JWT_TOKEN>' \
  --data-raw '{"limit":10,"offset":0,"sort_by":"created_at","order_By":"desc"}' \

Get video object

This API will show video's detail.

GEThttps://api.aiozstream.network/api/videos/:id

Parameters

id The unique identifier of the video.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Response

200: OK

{
    "status": "success",
    "data": {
                "id": "video_id",
                "user_id": "user_id",
                "title": "video's title (required)",
                "description": "",
                "metadata": null,
                "tags": null,
                "qualities": [
                    {
                        "name": "360p",
                        "status": "done",
                        "type": "hls"
                    },
                    {
                        "name": "720p",
                        "status": "done",
                        "type": "hls"
                    },
                    {
                        "name": "1080p",
                        "status": "done",
                        "type": "hls"
                    }
                ],
                "subtitles": null,
                "chapters": null,
                "player_theme": null,
                "duration": 283.492426,
                "size": 63109470,
                "is_mp4": false,
                "is_public": true,
                "is_panoramic": false,
                "status": "done",
                "created_at": "created_at",
                "updated_at": "updated_at",
                "assets": {
                    "source_url": "https://api.aiozstream.network/api/videos/video_id/source",
                    "thumbnail_url": "https://api.aiozstream.network/api/videos/video_id/thumbnail?resolution=original",
                    "hls_url": "https://api.aiozstream.network/api/videos/video_id/m3u8",
                    "mp4_url": "https://api.aiozstream.network/api/videos/video_id/mp4",
                    "iframe": "\u003ciframe src=\"https://embed.aiozstream.network/vod/video_id\" width=\"100%\" height=\"100%\" frameborder=\"0\" scrolling=\"no\" allowfullscreen=\"true\"\u003e\u003c/iframe\u003e",
                    "player_url": "https://embed.aiozstream.network/vod/video_id"
                },
                "player_theme_id": ""
    }
}

curl --location 'https://api.aiozstream.network/api/videos/video_id' \
--header 'accept: application/json, text/plain, */*' \
--header 'authorization: Bearer <YOUR_JWT_TOKEN>'

Calculate transcode price

This endpoint allows you to calculate the price to transcode your video based on your choice of qualities and video's duration.

GEThttps://api.aiozstream.network/api/videos/cost

Query

qualities Video's transcode qualities (allow: 144p, 240p, 360p, 480p, 720p, 1080p, 1440p, 2160p)

duration Video's duration

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Response

200: OK

curl --location 'https://api.aiozstream.network/api/videos/cost?duration=60&qualities=360p%2C1080p' \
--header 'accept: application/json' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Upload video part

This API allows you to upload your video or a part of it if your video's size is larger than chunk size (chunk size: 50MB - 200MB).

POSThttps://api.aiozstream.network/api/videos/:id/part

Parameters

video_id The unique identifier of the video.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Content-Range bytes {start_pos}-{end_pos}/{file_size}

Body

file* The video file to upload.

index* The index of the part to upload.

hash* Md5 hash of the part's content.

Response

200: OK

curl --location 'https://api.aiozstream.network/api/videos/video_id/part' \
--header 'accept: application/json, text/plain, */*' \
--header 'authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'content-range: bytes {start_pos}-{end_pos}/{file_size}' \
--form 'hash="part'\''s content MD5 hash"' \
--form 'index="part'\''s index"' \
--form 'file=@"/path/to/file"'

Upload video completed

This API notify server that video's uploading process is done.

GEThttps://api.aiozstream.network/api/videos/:id/complete

Parameters

id The unique identifier of the video.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Response

200: OK

curl --location 'https://api.aiozstream.network/api/videos/:id/complete' \
--header 'accept: application/json, text/plain, */*' \
--header 'authorization: Bearer <YOUR_JWT_TOKEN>'

Update video object

This API allow you to update video's information.

PATCHhttps://api.aiozstream.network/api/videos/:id

Parameters

id The unique identifier of the video.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Body

title Video's title

description Video's description

metadata Pairs of key and value

tags Video's tags

is_public Whether the video is publicly available or not (Default: true).

player_id The unique Id for the player you want to associate with your video.

Response

200: OK

curl --location --request PATCH 'https://api.aiozstream.network/api/videos/video_id' \
--header 'accept: application/json' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
  "description": "string",
  "player_id": "string",
  "is_public": true,
  "metadata": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "tags": [
    "string"
  ],
  "title": "string"
}'

Upload video thumbnail

This API allows you to upload a thumbnail for a certain video.

POSThttps://api.aiozstream.network/api/videos/:id/thumbnail

Parameters

video_id The unique identifier of the video.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Body

file* The thumbnail file to upload. (Allow: .png,.jpg)

Response

200: OK

curl --location 'https://api.aiozstream.network/api/videos/video_id/thumbnail' \
--header 'accept: application/json' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--form 'file=@"/path/to/file"'

Delete video

This API will delete certain video.

DELETEhttps://api.aiozstream.network/api/videos/:id

Parameters

id The unique identifier of the video.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Response

200: OK

curl --location --request DELETE 'https://api.aiozstream.network/api/videos/video_id' \
--header 'accept: application/json' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

PreviousPlayer setup and customization NextLive streamings