Skip to main content
GET
Search N images

Authorizations

API-Key
string
header
required

Query Parameters

q
string
default:""

Query filtering formula, must be url-encoded. Similarity uses i~, i~~, i~~~ for semantic similarity search and i=, i==, i=== for visual duplicate-detection search. i==== requests an additional, more precise duplicate-verification pass on the top candidate, slightly slower than the other comparisons; this mode is currently restricted to selected tenants.

page
integer
default:1

Page number. 1 is the first page.

Required range: x >= 1
limit
integer
default:50

Maximum number of images to return per page

Required range: 1 <= x <= 10000
sort_by
enum<string>
default:""

Sorting criterion. Note that sort_by=similarity only works if there are present "similary filters" on the Query Filtering Formula.

Available options:
,
image_id,
src,
url_img_watermark,
url_img_thumbnail,
height,
width,
aspect_ratio,
n_faces,
date,
title,
headline,
caption,
location,
city,
country,
event,
author,
provider,
shot,
scene,
medium,
technique,
similarity,
sim
sort_order
enum<string>
default:desc

Ascending or descending sorting.

Available options:
asc,
desc
fields
enum<string>[]

Array of fields to retrieve. Example: fields=image_id&fields=src

Available options:
image_id,
src,
src_path,
url_img_watermark,
url_img_thumbnail,
title,
headline,
caption,
alt_text,
ai_generated,
model_release,
property_release,
nsfw,
status,
date,
location,
city,
country,
event,
author,
provider,
shot,
scene,
technique,
medium,
keywords,
categories,
collections,
height,
width,
n_faces
facets
enum<string>[]

Array of facets to retrieve. Example: facets=author&facets=keywords

Available options:
ai_generated,
model_release,
property_release,
nsfw,
orientation,
status,
location,
city,
country,
event,
author,
provider,
shot,
scene,
medium,
technique,
keywords,
categories,
collections
count
boolean
default:false

Include total hit count?

lang
enum<string>
default:ml

Language code.

Available options:
ml,
en,
es

Response

Successful Response

results
image · object[]
required
count
integer
required
facets
Facets · object
required