Dreem icon

Dreem

AI-powered image generation with Dreem

Library → Search Shots

AI-generated

Summary

Searches the Dreem library for shots (poses) using a free-text keyword and optional filters for shot type and gender, returning a list of matching shots.

Inputs

  • Authentication (required) — Select either API Key or OAuth2 to authenticate with the Dreem API.
  • Search Keyword — Enter a free-text brief describing the shot (pose) to semantically search for. Leaving empty returns the newest shots instead of performing a semantic ranking.
  • Shot Type (required) — Choose to limit the search to a specific shot type: All, Product Shot, or Virtual Model. Note that Video shots are not returned as they are not in the semantic index.
  • Gender — Filter results by gender. This filter is applied only to Virtual Model shots; it is ignored for other shot types. Options are Any, Female, Male, or Unisex.
  • Limit (required) — Set the number of top-ranked shot matches to return. The value is clamped between 1 and 20.

Output shape

a list of shot objects matching the search criteria

The operation returns an array of shot objects from the Dreem library. The number of results is limited by the 'Limit' parameter. If no search keyword is provided, the newest shots are returned instead of a semantic search ranking. Video shots are never returned because they are not in the semantic index.

Examples

Example 1: Search for Virtual Model shots of a confident walking full body pose, limited to female gender, returning up to 5 results.

Set 'Authentication' (e.g., OAuth2), 'Search Keyword' to 'confident walking full body', 'Shot Type' to 'Virtual Model', 'Gender' to 'Female', and 'Limit' to 5.

Links

Discussion