v42

OpenAPI 3.1.0raw.githubusercontent.com2026-07-092767199.2 KB
v1

Image Search

Search the catalog by image (URL or base64), with pagination support.

Provide exactly one of image_url or base64_image. For text or text+image search, use POST /v1/search.

post/v1/image-search

Request body

image_urlstring nullable

Publicly accessible URL of the image to search with.

base64_imagestring nullable

Base64 encoded image bytes (no data URI prefix).

limitinteger nullable

Optional limit on the number of results. Default is 20, max is 30.

page_tokenstring nullable

Opaque token from a previous image-search response to fetch the next page of results.

segmentstring nullable

Image segmentation mode. None (default) disables segmentation. "AUTO" segments and crops the main product automatically. A custom string (e.g. "shoe", "mug") segments the specified object.

Response

Successful Response

next_page_tokenstring nullable

Token to fetch the next page. Null when no more results.