Created
February 6, 2026 16:51
-
-
Save 9Dave9/631d0337ab4283e03f3ade2e40a7209c to your computer and use it in GitHub Desktop.
updated-create-playlist-docs.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| **Features:** | |
| - Creates a playlist with specified images | |
| - Optional keywords and themes | |
| - Optional user association | |
| - Optional media types filtering | |
| - **NEW:** Find all files matching selected content types (image, video, gif) | |
| **Request Body:** | |
| - `playlist_name`: Required. Name of the playlist | |
| - `image_paths`: Optional (required if find_all_by_type is False). List of image paths to include | |
| - `keywords`: Optional. Keywords associated with the playlist | |
| - `ideas_themes`: Optional. Ideas or themes for the playlist | |
| - `user`: Optional. User who created the playlist | |
| - `media_types`: Optional. List of media types to process (e.g., ["image", "video", "gif"]) | |
| - `find_all_by_type`: Optional (default: False). Find all files matching selected content types instead of using keywords | |
| - `include_image`: Optional (default: True). Include image files when find_all_by_type is True | |
| - `include_video`: Optional (default: False). Include video files when find_all_by_type is True | |
| - `include_gif`: Optional (default: False). Include GIF files when find_all_by_type is True | |
| **Response:** | |
| - `success`: Boolean indicating if creation was successful | |
| - `message`: Human-readable message | |
| - `id`: ID of the created playlist (null if failed) | |
| **Example Request (with keywords):** | |
| ```json | |
| { | |
| "playlist_name": "Financial Documents Q1", | |
| "image_paths": ["/path/to/img1.jpg", "/path/to/img2.jpg"], | |
| "keywords": "invoice receipt", | |
| "ideas_themes": "Financial documents", | |
| "media_types": ["image", "video"] | |
| } | |
| ``` | |
| **Example Request (find all by type):** | |
| ```json | |
| { | |
| "playlist_name": "All Media Files", | |
| "find_all_by_type": true, | |
| "include_image": true, | |
| "include_video": true, | |
| "include_gif": true | |
| } | |
| ``` | |
| **Example Response:** | |
| ```json | |
| { | |
| "success": true, | |
| "message": "Playlist created successfully", | |
| "id": 10 | |
| } | |
| ``` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment