Retrieve answers

get

https://agent.cnstrc.com/v1/item_questions/{question}/answer

Retrieve the 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 Params

question

string

required

The question provided by the user as free-form text.

Query Params

key

string

required

The key of the index to use.

item_id

string

required

The ID of the item to return answer(s) for.

thread_id

uuid

A unique identifier for the conversation thread. This ID links multiple requests to the same conversation.

variation_id

string

The ID of the variation of the item to return answer(s) for.

guard

boolean

Defaults to false

Turn the content moderation check on or off. When on, shopper input is screened before the agent processes it.

num_results

integer

The number of answers to return.

string

The ID of the client and version that the request is coming from, such as cio-js-2.90.

array of strings

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.

User segments

string

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.

integer

An integer representing the user's session number (starting with 1), incremented after a 30 minute period of inactivity.

string

A globally unique identifier for the user browser (or mobile application instance) making the request.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Invalid request parameters.

500

Internal server error.

Language

Loading…

Response

Choose an example:

application/json

text/event-stream

👋 Welcome to Constructor's new and improved documentation

200AI-powered answer to question for a given item.

422Validation Error