v1
latestOpenAPI 3.1.02026-07-241765501.1 MBRetrieves answers
Retrieves AI powered answers to questions for a given item. If the client accepts server-sent events (text/event-stream content) response will be streamed back, otherwise complete response JSON is returned.
Path parameters
The question provided by the user as free-form text.
The question provided by the user as free-form text.
Query parameters
The key of the index to use.
The key of the index to use.
The id of the item to return answer(s) for.
The id of the item to return answer(s) for.
A unique identifier for the conversation thread. This ID links multiple requests to the same conversation.
A unique identifier for the conversation thread. This ID links multiple requests to the same conversation.
The id of the variation of the item to return answer(s) for.
The id of the variation of the item to return answer(s) for.
Enable or disable the moderation check.
Enable or disable the moderation check.
The number of answers to return.
The number of answers to return.
The id of the client and version that the request is coming from, such as cio-js-2.90.
The id of the client and version that the request is coming from, such as cio-js-2.90.
A customer defined context (such as vip-club-member) used to evaluate redirect or refined tag rules. Pass multiple segments by passing multiple us arguments.
A customer defined context (such as vip-club-member) used to evaluate redirect or refined tag rules. Pass multiple segments by passing multiple us arguments.
A customer generated anonymized identifier for a user on a customer website. It should only be sent for logged in customers and helps constructor to tie multiple client and session ID's together to form a behavioral data profile across devices.
A customer generated anonymized identifier for a user on a customer website. It should only be sent for logged in customers and helps constructor to tie multiple client and session ID's together to form a behavioral data profile across devices.
An integer representing the users session number (starting with 1), incremented after a 30 minute period of inactivity.
An integer representing the users session number (starting with 1), incremented after a 30 minute period of inactivity.
A globally unique identifier for the user browser (or mobile application instance) making the request.
A globally unique identifier for the user browser (or mobile application instance) making the request.
Response
AI powered answer to question for a given item.