API ReferenceSearchSearch

Hybrid Search

Search images using a text query that scores results against both visual content and text metadata (titles, captions, descriptions, and other text fields).This endpoint is in beta and requires special access, please contact the support team.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
dataset_idstringRequiredformat: "uuid"
The unique identifier for the dataset
text_querystringRequired
The text query to search for
negative_textstring or nullOptional
Optional text describing what to exclude from search results. Steers the visual query embedding away from this direction.
limitintegerOptional1-200Defaults to 100
Max number of items to return from hybrid search
datetime_filterobject or nullOptional
Filter results to only include items with timestamps within this datetime range
skip_moderationbooleanOptionalDefaults to false
Skip content moderation if enabled
moderation_score_typeenumOptional

Type of moderation scores to return when moderation is enabled.probability returns scores 0-1 using BGE Reranker model.level returns scores 0-5 using OpenAI model.This does not enable/disable moderation - use skip_moderation for that.

Response

Successful Response
datalist of objects
The results from hybrid search

Errors

422
Unprocessable Entity Error