v2
latestOpenAPI 3.1.02026-08-05245967.6 KBSearch
V2
Get Results
post/v2/search/results
Query parameters
portinteger nullable
Request body
cursorstring nullable
Used for cursor-based pagination. Set it to the cursor from the last response. If not set, will return the first results.
limitinteger nullable
Used for cursor-based pagination. Maximum number of results per response.
marketstring required
session_idstring nullable
Session identifier
metadataobject nullable
Metadata that can be used to modify the behaviour of the search.
tenantstring required
localestring nullable
The locale to use for the search. If not set, the default locale will be used.
user_idstring nullable
User identifier
dsidstring nullable
Populated for integrations performed by Depict.ai only. Depict.ai Session Id
querystring nullable
The search query.
Response
Successful Response
n_hitsinteger required
Total number of results for this query. Not necessarily exact.
search_request_idstring required
cursorstring nullable
Cursor that can be used in the next request to get subsequent results. If this is not set, there are no more results.
displaysobject[] required
The search results.
{"stackTrail":"components:schemas:SearchResponse:properties:debug_info:anyOf","oasType":"schema","type":"unknown","title":"Debug Info","nullable":true}