Sign in

v3

latestOpenAPI 3.1.0raw.githubusercontent.com2025-06-0554486.4 KB

Catalog Agent Search Products

Search for products using an LLM to generate a TextSearchQuery object that is used to search for products in the e-commerce catalog. The LLM will generate the fields of the TextSearchQuery object based on input query text.

get/catalog/agent_search

Query parameters

textstring required

Query text to be input to an LLM to generate a TextSearchQuery object

Query text to be input to an LLM to generate a TextSearchQuery object

limitinteger

The maximum number of results to return from the search.

The maximum number of results to return from the search.

Response

Successful Response

total_foundinteger required

The total number of products returned by the search.

errorstring nullable

The error message if the search query is invalid or the search failed. The products field will be an empty list if the search fails and total_found will be 0.