Image to Keyframes

Executes a visual similarity search that takes an input image (provided via public_url or upload_id) and searches within a specified dataset (dataset_id) to find visually similar frames from videos. The input image is encoded into an embedding using the dataset's configured encoder (e.g., Perception Encoder, or other vision-language embedding models), then the embedding is searched against all video frames in the dataset using vector similarity. Returns a ranked list of video frames ordered by similarity score, where each result includes the frame ID, parent video ID, similarity score, and optional composite slice information (e.g., which shot or scene the frame belongs to).

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.

Allowed values:
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