Send API

🚧

Beta Release

This endpoint is currently in beta and is subject to change. Request and response formats and behavior may change without prior notice.

Process a chat request with polymorphic request/response types. Request types are discriminated by 'requestType' field (general, productQuery, productSimilar, productComparison, productSearch, inspiration, imageSearch, content). Response messages are discriminated by 'messageType' field (text, productAnswer, productRecommendation, productComparison, productSearchResult, inspirationResult, content, topicDrift, errorResponse).

Query Params
string
required
length ≄ 1

Page URL used for beacon/analytics tracking.

string
required
length ≄ 1

Beacon session identifier used for analytics tracking.

string
required
length ≄ 1

Beacon page load identifier used for analytics tracking.

string

Shopper identifier used for beacon/analytics tracking.

string

Currency code used for beacon/analytics tracking

string
required
length ≄ 1

Chat session identifier returned from /v1/chat/init

string
required
length ≄ 1

Site identifier

string

User identifier used for beacon/analytics tracking

Body Params

Polymorphic chat request. The 'requestType' field determines the concrete type.

string
required
string
required
length between 0 and 256
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json