Create a new playlist

This endpoint creates a new playlist within a specified workspace. A playlist acts as a container for organizing media items either manually or based on filters and metadata.

Playlists can be created in two modes

  • Manual: Creates an empty playlist without any initial media items. Use this mode for manual curation, where you add items later in a user-defined sequence.
  • Smart: Auto-populates the playlist at creation time based on the filter criteria (for example, a video creation date range) that you provide in the request.

For more details, see Create and manage playlist.

How it works

  • When you send a POST request to this endpoint, FastPix creates a playlist and returns a playlist ID, using which items can be added later in a user-defined sequence.
  • You can create a smart playlist that is auto-populated based on the metadata in the request body.

Example

An e-learning platform creates a new playlist titled Beginner Python Series through the API. The response returns a unique playlist ID. The platform uses this ID to add a series of video tutorials to the playlist in a defined order. The playlist appears on the frontend as a structured learning path for learners.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to Playlist name

Name of the playlist.

string
required
Defaults to a1

Unique string value assigned by user to the playlist.

string
enum
required
Defaults to smart

For a smart playlist metadata is required.

Allowed:
string
Defaults to This is a playlist

Description for a playlist (Optional).

string
enum
Defaults to createdDate DESC

Determines the insertion order of media into playlist.

Allowed:
integer
Defaults to 1000

Optional parameter to limit no. of media in a playlist.

metadata
object

Required when the playlist type is smart. Media created between startDate and endDate of createdDate is added. Optionally, you can include media based on updatedDate.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json