Search

👍

Dynamic Yield new Experience Search is coming soon!

We’re making product discovery smarter, more intuitive, and effortless with API-based image and semantic product searches.

For the request structure and examples, see the API Reference.

The Search API enables seamless personalized search and discovery experiences. It's similar to the Choose API, however, some objects are structured a bit differently (see the API reference for details). The main distinction of the Search endpoint lies in its use of the query object, which is crucial for executing searches or starting conversations.

The Search API supports these search solutions:

• Semantic Search: A native AI-powered, multi-modal search solution that uses both image and text embedding to deliver highly relevant search results for natural language queries.
• Visual Search: An image-based search solution that enables users to search using images and retrieve visually similar or relevant products.

Query object fields

Required

Note: Either imageBase64 or text must be provided, but not both in the same request.

Optional

Visual Search example

{
  "query": {
    "imageBase64": "bGlnaHQgd29yay4=...",
    "filters": [],
    "sortBy": {}
  },
}

Semantic Search example

{
  "query": {
    "text": "<query>",
    "filters": [],
    "pagination": {},
    "sortBy": {}
  },
}