Shade icon

Shade

Interact with Shade API

Actions13

Asset → Search

AI-generated

Summary

Search for assets within a specified drive using an AI-based visual description query, optionally limiting the number of results returned.

Inputs

  • Workspace — Optionally select the workspace to use, either from a searchable list or by specifying its ID.
  • Drive (required) — Select the drive to search within, either from a list of drives in the chosen workspace or by ID.
  • Search Query (required) — Provide a visual description of the asset you want to find. The more detailed the description, the better the search results.
  • Limit — Specify the maximum number of search results to return; defaults to 50 if not set.

Output shape

a list of assets matching the visual search query

The search uses an AI-powered visual description to find assets within the specified drive. The response contains up to the specified limit of assets. Workspace selection is optional but influences drive selection and context.

Examples

Example 1: Find up to 10 assets depicting a 'sunset over mountains' in a given drive

Set the Drive parameter to the desired drive, enter 'sunset over mountains' as the Search Query, and set Limit to 10.

Links

Discussion