CHchannel3-ai
v1

Image Search

Changed on

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

  • Base URL
    https://api.trychannel3.com
  • URL
    https://api.trychannel3.com/v1/image-search
  • Auth
    API key in header x-api-key

Headers

x-user-idstring nullable

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

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.

Changes

  • 7aededb0a617Revision changes
    • info

      added the new optional request property /

  • f642382eaf91Revision changes
    • info

      added the new PL enum value to the request property //

    • info

      added the new PLN enum value to the request property //

    • info

      added the new pl enum value to the request property //