Skip to main content
The chat endpoint processes a shopper’s message and returns an AI-generated reply along with ranked product results, filter refinement options, and pagination metadata.

Endpoint

POST /chat/{convo_id}
No authentication required.

Path Parameters

convo_id
string
required
Unique identifier for the conversation session. Generate a new ID per user session.

Request Body (ShopperInput)

chat
string
The user’s free-text shopping message, e.g. "I'm looking for running shoes under $100".
refinement_selection
object
A refinement choice the user selected. Contains category (string) and selection (string).
product_filter
object
Price range filter. Contains low_price (number, optional) and high_price (number, optional).

Example Request

curl -X POST https://rewardsbot-prod.liquidrewardsapi.com/chat/my-session-id \
  -H "Content-Type: application/json" \
  -d '{
    "chat": "I want wireless headphones under $200"
  }'

Response (ShopperReply)

agent_reply
string | null
The AI assistant’s text response to the user.
found_products
object | null
Products found matching the query.
product_warning
string | null
Optional warning message about product availability or results.
refinement_result
object | null
Suggested refinement options for the user.
pagination
object | null
Pagination metadata for fetching additional results.

Error Responses

Status CodeDescription
422 Unprocessable EntityValidation error in request body