Actions10
- Generative Content Actions
- Library Actions
- Task Actions
Library → Get Video Prompts
AI-generatedSummary
Retrieve a paginated list of system video generation prompts from the Dreem library, optionally filtering by gender and keyword search.
Inputs
- Authentication (required) — Choose between API Key or OAuth2 authentication to authenticate with the Dreem API.
- Gender — Filter video prompts by gender: All (0), Female (2), Male (1), or Unisex (3). Defaults to All.
- Search Keyword — Optional keyword to search and filter video prompts.
- Page Number — Page number to retrieve for pagination, starting at 1. Defaults to 1.
- Page Size — Number of prompts to return per page, between 1 and 100. Defaults to 20.
Output shape
a list of video prompt objects
Each prompt includes properties such as id, name, description, and sourceType. Only prompts with sourceType 'SYSTEM' are returned. Pagination is supported via 'Page Number' and 'Page Size' parameters.
Examples
Example 1: Retrieve first page of all system video prompts filtered by keyword 'walking'
Set Authentication to desired method, Gender to 'All', Search Keyword to 'walking', Page Number to 1, and Page Size to preferred number (e.g., 20).
Example 2: Retrieve second page of female-specific video prompts
Set Gender to 'Female', Page Number to 2, and optionally adjust Page Size.