Skip to main content
POST
/
v1
/
image-search
Python
import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
page = client.products.search_by_image()
page = page.products[0]
print(page.id)
{ "products": [ { "id": "<string>", "title": "<string>", "description": "<string>", "brands": [ { "id": "<string>", "name": "<string>" } ], "images": [], "categories": [], "gender": "male", "age": "newborn", "materials": [ "<string>" ], "key_features": [ "<string>" ], "offers": [ { "url": "<string>", "domain": "<string>", "price": { "price": 123, "currency": "<string>", "compare_at_price": 123 }, "availability": "InStock", "max_commission_rate": 0 } ] } ], "next_page_token": "<string>" }

Documentation Index

Fetch the complete documentation index at: https://docs.trychannel3.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Body

application/json

Image-only search request.

​
image_url
string | null

Publicly accessible URL of the image to search with.

​
base64_image
string | null

Base64 encoded image bytes (no data URI prefix).

​
limit
integer | null
default:20

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

Required range: x >= 1
​
filters
SearchFilters · object

Optional filters. Search will only consider products that match all of the filters.

​
config
LocaleConfig · object

Optional locale configuration.

​
page_token
string | null

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

Response

Successful Response

v1 paginated search response.

​
products
Product · object[]
required
​
next_page_token
string | null

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