Skip to main content

Search APIs

Perform search for a given index.

Endpoint

GET https://api.conversecart.com/search/

Input

ParameterTypeRequiredDescription
querystringYesThe search query string.
indexIDstringYesThe ID of the index to search against.
sessionIDstringNoThe ID of the user’s search session generated in the previous step.
top_kintegerNoThe maximum number of results to return. Default value is 30.
locintegerNoThe location of the search query. Currently This future is not supported.

JSON Response example

{
"searchID": "<searchID>",
"results": [...]
}

Search by ID

Finds documents similar to the specified document in the given index.

Endpoint

GET https://api.conversecart.com/search/similar

Input

ParameterTypeRequiredDescription
documentIDstringYesThe ID of the document to find similar items to.
indexIDstringYesThe ID of the index to search against.
sessionIDstringNoThe ID of the user’s search session generated in the previous step.
top_kintegerNoThe maximum number of results to return. Default value is 30.
locintegerNoThe location of the search query. Currently This future is not supported.

JSON Response example

{
"searchID": "<searchID>",
"results": [...]
}