Interaction with bot addressed by route

post

https://example.com/gateway/route/stream

Endpoint used to conduct conversation with the bot of the project that the given route currently serves. Routes are configured in the admin panel. It accepts user input and responds with bot answers. A conversation stays with the project it started with until it ends, even when the route is switched to another project in the meantime. Returns response in Sever-sent events format. Stream contains zero or more PartialResponse events followed by exactly one Response or Error event. The final Response event contains all partial responses. A route the platform cannot serve (unknown route, route without a live project) ends the stream with an Error event whose code is 400; a route whose project is not available on the platform ends it with an Error event whose code is 500.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Bot gateway request

Bot gateway request addressed by route name instead of project uuid

route

object

required

Route that selects which project's bot responds

text

string

required

Message sent by user

source_type

string

enum

required

Type of the source by which user is contacting. For example:
- phone - user is contacting by phone
- twitter - user message comes from twitter integration

author

string

required

length ≤ 128

Name of the author of the message.

suid

string

required

length ≤ 64

Session identifier. Session is unique identifier for one particular session. It can be an uuid or just random string.
If bot responds to user and integrator wants to send another message in the same context it has to attach the same suid
Example:
1. User sends first message in the conversation - set the suid for ex. "r123111-a99c-480c-89e1-e26b2f3f76b7"
2. Gateway returns message to user
3. User says something more in that particular conversation - use the same suid as before "r123111-a99c-480c-89e1-e26b2f3f76b7"

extra_data

Additional, optional data attached to the request and usable by the bot. Two forms are accepted:
(1) an object of key/value pairs - every value is treated as non-sensitive and kept for the whole conversation;
(2) an array of self-describing entries, where each entry declares its own sensitivity and lifetime.
A sensitive value may be used by the bot but is never shown in cleartext (masked in analytics and logs, encrypted at rest).
A request-lifetime value is available only for the current turn and is not persisted.

Headers

X-Auth-Mode

string

enum

Marks the request as carrying confidential user input, e.g. a password, PIN or one-time code entered during authentication.
When the header is present, the message text is not stored in cleartext anywhere in the platform: it is replaced with [confidential] in the conversation history, analytics and transcriptions, the request body is masked in logs, and NLU results for the message are not persisted. The bot itself still receives the original text and processes it normally.
The flag is propagated to all internal services handling the request. Any value enables the mode; true is the conventional one. Omit the header for regular messages.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Success

400Bad Request

401Unauthorized

429Too Many Requests - rate limit exceeded (per IP or per session)