v1

latestOpenAPI 3.1.02026-08-04118425322.0 KB

search > search

Text to Image Search

Search a dataset with a natural-language query and get back the images that best match it. Use this when you want to find visuals by describing what's in them.For example, search for a sunset at the beach or Jalen Hurts holding the Vince Lombardi trophy. Pair the text query with exact-match metadata filters to narrow results further.

post/api/v1/search/text-to-image

Headers

Authorizationstring required

Bearer authentication

Request body

dataset_idstring uuid required

The unique identifier for the dataset

offsetinteger

Starting index to return

limitinteger

Max number of items to return

moderation_score_type'probability' | 'level'

Score type returned by the moderation service.

PROBABILITY: Scores in range 0-1 (uses BGE Reranker model)
LEVEL: Scores in range 0-5 (uses OpenAI model)

text_querystring required

The text query to search for

negative_textstring nullable

Optional text describing what to exclude from search results. Steers the query embedding away from this direction.

asset_type'image' | 'video'

skip_moderationboolean

Skip content moderation if enabled

Response

Successful Response