Skip to main content
POST
Find similar indexed images

Authorizations

X-API-Key
string
header
required

Your Lightdrift API key. Usage is metered per query.

Headers

Idempotency-Key
string
default:""

Body

application/json
asset_id
string
required
k
integer
default:10

Results to return. Each 10 results use 1 credit, rounded up.

Required range: 1 <= x <= 100
ann_k
integer
default:100
Required range: 1 <= x <= 1000
ann_ef
integer
default:2048
Required range: 64 <= x <= 4096
explain
boolean
default:false
filters
Filters · object
client_session
string | null

Response

Search results and source-declared rights.

query_id
string
results
object[]
latency_ms
integer
timing_ms
object
mode
string
ranking
string

text, image, multimodal, none, or none (degraded). Multimodal scores fuse similarity and text ranks; scores are not probabilities.

pool_size
integer
reranked
integer
backend
string

Search responses report voyage.

degraded
string

Reranker unavailable; results are in retrieval order. This is a successful response and uses credits.

relaxed
string[]

Default filters relaxed to fill results; explicit constraints are not relaxed.

query_type
enum<string>

Input modality for /v1/search.

Available options:
text,
image,
image_text
credits
object

Credits used by this call and credits left on the account. A search uses 1 credit per 10 results, rounded up, minimum 1.

notice
object

Present only when the request was changed to fit the plan. On the Free plan, k above 10 is capped to 10 results.