Sign in

v1

latestOpenAPI 3.1.02026-07-13161952.2 KB
Images

Search N images

Do simple image listing or do advanced image search with filters, sorting, pagination, facets and counting

get/imgs

Query parameters

qstring

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.

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.

pageinteger

Page number. 1 is the first page.

Page number. 1 is the first page.

limitinteger

Maximum number of images to return per page

Maximum number of images to return per page

sort_by'' | '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'

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

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

sort_order'asc' | 'desc'

Ascending or descending sorting.

Ascending or descending sorting.

fieldsstring[]

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

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

facetsstring[]

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

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

countboolean

Include total hit count?

Include total hit count?

lang'ml' | 'en' | 'es'

Language code.

Language code.

Response

Successful Response

countinteger required
facetsobject required

Example response

{
  "results": [
    {
      "src": "https://cdn.example.com/image/source.jpg",
      "url_img_watermark": "https://cdn.example.com/image/wm.jpg",
      "url_img_thumbnail": "https://cdn.example.com/image/thumb.jpg",
      "title": "image123",
      "headline": "Sunset over the Hudson River",
      "caption": "A vibrant orange sunset reflecting on the river with the city skyline in silhouette.",
      "status": "Active",
      "date": "2024-10-19",
      "location": "123 Main St, near Central Park",
      "city": "New York",
      "country": "United States",
      "event": "Oscar awards 2024",
      "author": "Jane Doe",
      "provider": "Acme Inc.",
      "shot": "Portrait",
      "scene": "Town square",
      "technique": "Drawing",
      "medium": "Oil on canvas",
      "keywords": [
        "Tree",
        "Dog",
        "Ball",
        "Water"
      ],
      "categories": [
        "Sport",
        "Fashion",
        "Politics"
      ],
      "collections": [
        "Steet pics",
        "Exclusive"
      ]
    }
  ]
}