---
title: "Search N images"
method: GET
path: "/imgs"
tags: ["Images"]
---

# Search N images

`GET /imgs`

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

## Query parameters

- `q` string — 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 — Page number. 1 is the first page.
- `limit` integer — 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.
- `sort_order` 'asc' | 'desc' — Ascending or descending sorting.
- `fields` string[] — Array of fields to retrieve. Example: fields=image_id&fields=src
- `facets` string[] — Array of facets to retrieve. Example: facets=author&facets=keywords
- `count` boolean — Include total hit count?
- `lang` 'ml' | 'en' | 'es' — Language code.

## Response `200`

Successful Response

- ImageSearchResponse
  - `results` Image[], required
    - `image_id` string, nullable
    - `src` string, nullable — Url of the image in high or medium resolution (used as source for the AI).
    - `url_img_watermark` string, nullable — URL of the watermarked image.
    - `url_img_thumbnail` string, nullable — URL of the thumbnail image.
    - `title` string, nullable — A shorthand reference for the image.
    - `headline` string, nullable — Short text describing the image.
    - `caption` string, nullable — Long text describing the image.
    - `alt_text` string, nullable — Text describing the visual appearance of an image (Accessibility).
    - `ai_generated` boolean, nullable — Image generated by Artificial Intelligence.
    - `model_release` boolean, nullable — image with model release.
    - `property_release` boolean, nullable — image with property release.
    - `nsfw` boolean, nullable — Image Not Safe For Work.
    - `status` string, nullable — Current status of the image.
    - `date` string, nullable — Date of the image creation in year-month-day format. Capture date for photographies.
    - `location` string, nullable — A detailed description of the location, complementing the specified country and city with additional details such as street address or notable landmarks.
    - `city` string, nullable — Name of the country.
    - `country` string, nullable — Name of the country.
    - `event` string, nullable — Related event
    - `author` string, nullable — The name of the individual or entity responsible for creating the image, such as a photographer or painter.
    - `provider` string, nullable — The identifier of the provider, which can be either a unique numeric ID or a descriptive name.
    - `shot` string, nullable — Type of photography shot.
    - `scene` string, nullable — Spot, place, visual location
    - `technique` string, nullable — The specific method or process used in creating the artwork, reflecting the artist's unique approach or the traditional methods tied to certain mediums.
    - `medium` string, nullable — The material or substance used in the creation of the artwork or object. This field corresponds to various artistic mediums like oils, acrylics, or digital formats.
    - `keywords` string[], nullable — Specific tags describing the image
    - `categories` string[], nullable — General categories of the image
    - `collections` string[], nullable — Collections that the image belongs to
    - `height` integer, nullable — Height of the image.
    - `width` integer, nullable — Width of the image.
    - `n_faces` integer, nullable — Num of people faces that appears on the image.
  - `count` integer, required
  - `facets` object, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/wesog/apis/wesog-api.md) · [All operations](https://skmtc.net/wesog/apis/wesog-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wesog/wesog-api/revisions/97381dd1ff4c/schema)