CHchannel3-ai
v1

Search

Changed on

Search for products with pagination support.

At least one of query, image_url, base64_image, or page_token must be provided; requests with none of these will return 422.

post/v1/search

Request

  • Base URL
    https://api.trychannel3.com
  • URL
    https://api.trychannel3.com/v1/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

querystring nullable

Search query. At least one of query, image_url, base64_image, or page_token must be provided.

image_urlstring nullable

Image URL. At least one of query, image_url, base64_image, or page_token must be provided.

base64_imagestring nullable

Base64 encoded image. At least one of query, image_url, base64_image, or page_token must be provided.

limitinteger nullable

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

page_tokenstring nullable

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

Response

Successful Response

next_page_tokenstring nullable

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

Changes

  • de4ceb9ccdefRevision 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 //