AIOZ Stream API
Playlist

Playlist API

Create video playlist

This API allows you to create a video playlist with form-data.

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

Headers

Authorization Bearer your_access_token_here
stream-public-key your_public_key_here
stream-secret-key your_secret_key_here

Body

name* The name of the playlist
tags Playlist's tags
metadata Playlist's metadata

Response

200: Created
{
  "status": "success",
  "data": {
    "playlist": {
      "id": "playlist_id",
      "user_id": "user_id",
      "name": "playlist_name",
      "created_at": "2024-01-01T11:11:11.111111Z",
      "updated_at": "2024-01-01T11:11:11.111111Z",
      "item_count": 0,
      "video_items": null,
      "duration": 0,
      "size": 0
    }
  }
}
curl --location 'https://api.aiozstream.network/api/playlists/create' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--form 'name="your playlist name"'

Get user playlists

POSThttps://api.aiozstream.network/api/playlists

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
limit The maximum number of records to return in a query
sort_by Field to sort by created_at, name
order_by Sort direction
search Search by playlist name
tags Playlist's tags
metadata Playlist's metadata

Response

200: OK
{
    "status": "success",
    "data": {
        "playlists": [
            {
                "id": "playlist_id",
                "user_id": "user_id",
                "name": "playlist_name",
                "thumbnail_url": "thumbnail_url",
                "created_at": "2024-01-01T11:11:11.111111Z",
                "updated_at": "2024-01-01T11:11:11.111111Z",
                "item_count": 2, // total video in playlist
                "video_items": null,
                "duration": 10, // total duration of playlist
                "size": 0, // total size of playlist
                "playlist_url": "playlist_url",
                "iframe": "iframe"
            },
            {
                "id": "playlist_id",
                "user_id": "user_id",
                "name": "playlist_name",
                "thumbnail_url": "thumbnail_url",
                "created_at": "2024-01-01T11:11:11.111111Z",
                "updated_at": "2024-01-01T11:11:11.111111Z",
                "item_count": 2, // total video in playlist
                "video_items": null,
                "duration": 10, // total duration of playlist
                "size": 0, // total size of playlist
                "playlist_url": "playlist_url",
                "iframe": "iframe"
            },
        ],
        "total": 2
    }
}
 
curl --location 'https://api.aiozstream.network/api/playlists' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--form 'Offset="0"' \
--form 'Limit="10"' \
--form 'sort_by="name"' \
--form 'order_by="asc"' \
--form 'search="your playlist name"'

Get playlist by id

This API allows you to get a playlist by id. Inside the playlist, you will get the videos you have added to the playlist.

Note: If sort_by and order_by parameters are not provided, playlist items will be returned in their custom order (the order in which they were arranged in the playlist).

GEThttps://api.aiozstream.network/api/playlists/playlist_id

Parameters

playlist_id* The unique identifier of the playlist
sort_by Field to sort by created_at, title, duration
order_by Sort direction (options: asc, desc)

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": {
        "playlist": {
            "id": "playlist_id",
            "user_id": "user_id",
            "name": "playlist_name",
            "thumbnail_url": "thumbnail_url",
            "created_at": "2024-01-01T11:11:11.111111Z",
            "updated_at": "2024-01-01T11:11:11.111111Z",
            "item_count": 2,
            "video_items": [
                {
                    "id": "video_id",
                    "playlist_id": "playlist_id",
                    "video_id": "video_id",
                    "next_id": "next_id",
                    "previous_id": null,
                    "created_at": "2024-01-01T11:11:11.111111Z",
                    "updated_at": "2024-01-01T11:11:11.111111Z",
                    "video": {
                        "thumbnail_url": "thumbnail_url",
                        "title": "title",
                        "qualities": "480p",
                        "duration": 10
                    }
                },
                {
                    "id": "video_id",
                    "playlist_id": "playlist_id",
                    "video_id": "video_id",
                    "next_id": null,
                    "previous_id": "previous_id",
                    "created_at": "2024-01-01T11:11:11.111111Z",
                    "updated_at": "2024-01-01T11:11:11.111111Z",
                    "video": {
                        "thumbnail_url": "thumbnail_url",
                        "title": "title",
                        "qualities": "480p",
                        "duration": 10
                    }
                }
            ],
            "duration": 20,
            "size": 0, // total size of playlist
            "playlist_url": "playlist_url",
            "iframe": "iframe"
        }
    }
}
curl --location 'https://api.aiozstream.network/api/playlists/playlist_id' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Update playlist by id

This API allows you to update a playlist by id with form-data.

Field description:

  • file (file): The thumbnail of the playlist. Without thumbnail, the playlist will use the default thumbnail of the first video in the playlist. The format must be jpg, jpeg, or png.
PATCHhttps://api.aiozstream.network/api/playlists/playlist_id

Parameters

playlist_id* The unique identifier of the playlist

Headers

Authorization Bearer your_access_token_here
stream-public-key your_public_key_here
stream-secret-key your_secret_key_here

Body

name The new name of the playlist
file The new thumbnail of the playlist
metadata Playlist's metadata
tags Playlist's tags

Response

200: OK
{
    "status": "success",
    "message": "Update playlist successfully."
}
curl --location --request PATCH 'https://api.aiozstream.network/api/playlists/playlist_id' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--form 'name="new_playlist_name"' \
--form 'file=@"/path/to/your/file.jpg"'

Add video to playlist

This API allows you to add a video to a playlist with body json.

The request body when adding a video to a playlist will be like this:

{
  "video_id": "video_id"
}
POSThttps://api.aiozstream.network/api/playlists/playlist_id/items

Parameters

playlist_id* The unique identifier of the playlist

Headers

Authorization Bearer your_access_token_here
stream-public-key your_public_key_here
stream-secret-key your_secret_key_here

Body

video_id* The unique identifier of the video

Response

200: OK
{
    "status": "success",
    "message": "Add video to playlist successfully."
}
curl --location 'https://api.aiozstream.network/api/playlists/playlist_id/items' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
    "video_id": "video_id"
}'

Move video on playlist

This API allows you to move a video on a playlist.

Field description:

  • playlist_id (string): The unique identifier of the playlist
  • current_id (string): The unique identifier of the video you want to move.
  • next_id (string): The unique identifier of the video you want to move after the current video.
  • previous_id (string): The unique identifier of the video you want to move before the current video.

The request body when moving a video on a playlist will be like this:

Examples:

  1. Move to top:

    {
  "current_id": "current_item_id",
  "next_id": "next_item_id"
}

  2. Move to bottom:

    {
  "current_id": "current_item_id",
  "previous_id": "last_item_id"
}

  3. Move between two items:

    {
  "current_id": "current_item_id",
  "next_id": "next_item_id",
  "previous_id": "previous_item_id"
}

Note: The current_id is always required. Use next_id and previous_id to specify the new position.

Important: If the specified position is invalid (e.g., wrong position of next_id or previous_id), the operation will fail and return an error. The playlist will remain unchanged in such cases.

To move a video to the top of the playlist, set next_id to the ID of the first video in the playlist. To move a video to the bottom, set previous_id to the ID of the last video in the playlist. If both next_id and previous_id are provided, the video will be placed between these two videos.

PUThttps://api.aiozstream.network/api/playlists/playlist_id/items

Parameters

playlist_id* The unique identifier of the playlist

Headers

Authorization Bearer your_access_token_here
stream-public-key your_public_key_here
stream-secret-key your_secret_key_here

Body

current_id* The unique identifier of the video you want to move.
next_id The unique identifier of the video you want to move after the current video.
previous_id The unique identifier of the video you want to move before the current video.

Response

200: OK
{
    "status": "success",
    "message": "Update playlist successfully."
}
curl --location --request PUT 'https://api.aiozstream.network/api/playlists/playlist_id/items' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
    "current_id": "current_item_id",
    "next_id": "next_item_id",
    "previous_id": "previous_item_id"
}'

Delete playlist item

This API allows you to delete a playlist item by playlist id.

DELETEhttps://api.aiozstream.network/api/playlists/playlist_id

Parameters

playlist_id* The unique identifier of the playlist

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",
    "message": "Delete playlist successfully."
}
curl --location --request DELETE 'https://api.aiozstream.network/api/playlists/playlist_id' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Delete item from playlist

This API allows you to delete a playlist item by playlist id.

DELETEhttps://api.aiozstream.network/api/playlists/playlist_id/items/item_id

Parameters

playlist_id* The unique identifier of the playlist

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",
    "message": "Video removed from playlist successfully."
}
curl --location --request DELETE 'https://api.aiozstream.network/api/playlists/playlist_id/items/item_id' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Delete playlist thumbnail

This API allows you to delete a playlist thumbnail.

DELETEhttps://api.aiozstream.network/api/playlists/playlist_id/thumbnail

Parameters

playlist_id* The unique identifier of the playlist

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",
    "message": "Deleted playlist thumbnail successfully."
}
curl --location --request DELETE 'https://api.aiozstream.network/api/playlists/playlist_id/thumbnail' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--data ''
PreviousPaymentsNextGo