Skip to main content
POST
Find products in an image
Pass config.collection_id to search each detected thing inside a collection.

Authorizations

x-api-key
string
header
required

Headers

x-user-id
string | null

Optional user identifier to attribute clicks and sales to a user in your system. Channel3 appends it to buy URLs in the response.

Body

application/json

Find purchasable products in a scene image, grouped by detected thing.

image_url
string | null

Publicly accessible URL of the image.

base64_image
string | null

Base64 encoded image bytes (no data URI prefix).

limit
integer
default:10

Max catalog matches per detected thing.

Required range: 1 <= x <= 30
filters
SearchFilters · object

Applied identically to every per-thing catalog search.

config
ImageSearchConfig · object

Locale and optional collection scope.

max_things
integer
default:6

Cap on named objects to detect and search.

Required range: 1 <= x <= 6

Response

Successful Response

things
DetectedThing · object[]
required
image_size
integer[]
required

[width, height] of the image the boxes are relative to.