Send Message (Streaming)

post

https://gus.assistant.unbxd.io/v1/sites/{sitekey}/conversation/{conversationid}/chat/stream

Sends the same request as Send a message, but streams progress and final-answer events using Server-Sent Events. Parse each data: line as JSON. The stream may emit progress updates, one final answer, then event: complete; failures after streaming begins arrive as event: error. A POST-capable SSE client or fetch streaming is required.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sitekey

string

required

Your site key, provided during onboarding. The site key is associated with a specific region.

conversationid

string

required

Conversation ID returned by Start a conversation.

Query Params

uid

string

required

Stable identifier for the shopper. Use the same value that started the conversation.

Body Params

message

string

required

length ≤ 1000

The shopper's message. Maximum 1,000 characters.

image

string

Optional image for visual search: a public image URL, a data URL, or plain base64-encoded image data. Visual search must be enabled for the site.

filters

array of objects

Optional refinements selected from filters returned by a previous reply. Send only the new selections.

filters

metadata

array of objects

Optional integration-controlled product-search settings. Supported names are fields and filter; each value is an array of strings.

metadata

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

404

Wrong path or HTTP method.

502

Service temporarily unavailable or timed out.

503

Service temporarily unavailable.

504

Gateway timeout.

200Server-Sent Events stream. Progress and final-answer events contain JSON in data lines; event names may include complete and error.

400Invalid request, such as missing uid, invalid JSON, or message longer than 1,000 characters.

500The assistant could not complete the request.