Ask the vendor AI assistant

Send a prompt to the vendor-specific AI assistant. The response is grounded in the
authenticated vendor's uploaded knowledge base and persona configuration. A session ID
can be supplied to continue an existing conversation; otherwise a new session is created.

Response semantics:

  • ai_response.products: Always an empty array. The assistant no longer recommends catalogue
    products — a customer asking what to use or buy is steered into the skin scan instead, since
    the scan is what personalised recommendations are built from. The key is retained so existing
    clients continue to parse the response unchanged.
  • ai_response.actions: List of non-visual action markers emitted by the assistant to drive UI behavior.
    • "SKIN_SCAN": show a call-to-action for the user to take a skin scan. This is the primary
      response to a product question.
    • "BOOK_CONSULTATION": surface an option to connect the user with a human consultant or
      aesthetician.
      Markers are not part of the visible assistant text; they are provided only for clients to
      render contextual UI affordances.
  • persona: Snapshot of the vendor's active persona that shaped the reply. Includes tone,
    communication_style, brand_character, and optional custom_emphasis. Clients can surface this
    metadata (e.g., in a conversation header) or log it for analytics.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 2 and 1500

Prompt or question for the assistant (2-1500 characters)

uuid | null

Existing session identifier to continue a conversation

string | null

Skin analysis batch identifier used to ground responses with scan insights

string | null

Email-verification token from POST /widget/chat/verify-code. Required only when the
vendor gates the chat (Tulip orders enabled): the customer must verify their email
(via request-codeverify-code) before the assistant will answer, and this token
must be sent as user_email's proof on every request. When verification is required
and the token is absent or invalid the request returns 401 {"message":"Verification required."}. Ignored for vendors that do not gate the chat.

attachment_ids
array of integers | null

Ids of images the customer previously uploaded via POST /widget/chat/attachments.
Each is bound to this turn's message and shown to staff in the live-chat inbox. The
assistant is told photos were attached (as a text marker) but does not analyse the
images. Ignored unless the vendor has the chat_attachments feature enabled. A file
that is unknown, already used, or belongs to another vendor rejects the request (422).

attachment_ids
Responses

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