Retrieve by image

post

https://image-search.cnstrc.com/v2/image_search

Retrieve AI optimized search results for products (or optionally other sections) by image with optional multi-item detection (segmentation) support.

Related content

Query Params

key

string

required

length between 1 and 100

The key of the index to use.

section

string

length between 1 and 100

Defaults to Products

The section of the index to use.

search_crop_type

string

enum

Defaults to bbox

How to crop detected segments for visual search. Only relevant when use_segmentation is true.

Allowed:

variations_map

json

A JSON string containing a instructions on how to map item variation data in the response (typically used for swatches). More details, including the exact schema for this value can be found here

fmt_options

object

An object containing options to format different aspect of the response.

string

length between 1 and 100

The ID of the client and version that the request is coming from, such as cio-js-2.90.

array of strings

A customer defined context (such as vip-club-member) used to evaluate redirect or refined tag rules. Pass multiple segments by passing multiple us arguments.

use_segmentation

boolean

Defaults to false

Whether to detect and individually search multiple objects in the image. When true, the image is split into detected objects and each is searched separately; results are merged.

string

A customer generated anonymized identifier for a user on a customer website. It should only be sent for logged in customers and helps Constructor to tie multiple client and session IDs together to form a behavioral data profile across devices.

return_segments

boolean

Defaults to false

Whether to include per-segment metadata in the response. Only applicable when use_segmentation is true.

integer

An integer representing the users session number (starting with 1), incremented after a 30 minute period of inactivity.

string

A globally unique identifier for the user browser (or mobile application instance) making the request.

Body Params

Raw image bytes. Supported formats: JPEG, PNG, WebP, GIF. Maximum size: 6 MB.

Responses

👋 Welcome to Constructor's new and improved documentation

200OK

400Bad Request