API Reference

Create new playlist

Creates a new video playlist for the authenticated user

POST /playlist

Detailed Description

Creates a new video playlist for the authenticated user. Use this when starting a new curated list of videos with configurable access rules and optional external button metadata.

HTTP Method & Path

POST /playlist

Authentication Requirements

  • Security Scheme: PandaAuth (apiKey)
  • Header: Authorization: <your_api_token> (no Bearer prefix)

Parameters

NameTypeRequiredDescription
Authorizationstring (header)YesPanda API token (without Bearer prefix)

Request Body

Schema: CreatePlaylistRequest

NameTypeRequiredDescription
namestringYesPlaylist name. minLength=1, maxLength=255.
descriptionstringNoOptional description. maxLength=1000.
access_typestringYesOne of public, private, anyone_with_password.
passwordstringConditionallyRequired if access_type=anyone_with_password. minLength=6.
hide_viewsbooleanNoHide total views publicly. Default false.
creator_namestringYesDisplay name of the playlist creator. minLength=1, maxLength=255.
external_buttonobject (ExternalButton)NoOptional external call-to-action button.
image_idstring (uuid)NoOptional cover image identifier.

Schema: ExternalButton

NameTypeRequiredDescription
sizestringYesOne of small, medium, large.
textstringYesButton label. minLength=1, maxLength=50.
urlstring (uri)YesDestination URL.

Example Request Body

{
  "name": "My Playlist",
  "description": "A collection of tutorial videos",
  "access_type": "public",
  "hide_views": false,
  "creator_name": "John Doe",
  "external_button": {
    "size": "medium",
    "text": "Visit Website",
    "url": "https://example.com"
  },
  "image_id": "a6d1f7c8-1c2b-4d5e-9a10-1b2c3d4e5f60"
}

Notes

  • If access_type is changed to password-protected later, ensure you provide a password that meets the minimum length.
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!