API ReferenceSearchSearch

Image to Keyframes Search

Find video keyframes that look similar to a reference image. Provide the reference as a public_url or upload_id.Returns a ranked list of matching frames with their parent video.

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
offsetintegerOptional0-9223372036854776000Defaults to 0
Starting index to return
limitintegerOptional1-1000Defaults to 100
Max number of items to return
metadata_filtersobject or nullOptional
List of metadata filters to apply to the search
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.

coactive_image_idstring or nullOptionalformat: "uuid"
public_urlstring or nullOptional
upload_idstring or nullOptional
skip_moderationbooleanOptionalDefaults to false
Skip content moderation if enabled

Response

Successful Response
datalist of objects

Errors

422
Unprocessable Entity Error