API Reference
Release NotesPostman CollectionUI LibrariesClient Libraries

Retrieve by intent

get
https://agent.cnstrc.com/v1/intent/

Retrieve AI-powered product discovery suggestions based on conversational free-form text. Returns results in small batches using a real-time Server-sent Events stream for a dynamic user experience.

Path Params
string
required

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

Query Params
string
required

The key of the index to use.

uuid

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

string

A URL-encoded JSON string containing filters (inaccessible to end users) used to narrow the result set. Applied before filters accessible to end users. Does not affect facet counts. Only results that match the filters are returned. More details on https://docs.constructor.com/reference/shared-pre-filter-expressions

string
required

The domain specifying a set of specific instructions for processing the intent, e.g., 'recipes', 'sportsgear'.

boolean
Defaults to false

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

integer

The maximum number of result events to return.

integer
deprecated

Deprecated. Please, use num_results_per_event instead.

integer

The maximum number of results to return per search_result event.

fmt_options
object

An object containing options to format different aspects of the response.

string

A URL-encoded JSON string. More details on https://docs.constructor.com/reference/search-search-results#using-the-qs-parameter

string

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

us
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.

Updated 4 months ago

Did this page help you?
Language
LoadingLoadingā€¦
Response
Choose an example:
text/event-stream
application/json

Updated 4 months ago

Did this page help you?