Chat bot
Start
Starts a chat session from a visitor's first message on a public form that has the AI chat bot enabled, creating a requesterless ticket in the form's group that holds that message, and returning its ticket number plus the session token every follow-up call needs. The answer is generated strictly from the workspace's approved FAQs, and found is false with no reply when nothing matched or the model declined to answer. Requests are rejected without a valid reCAPTCHA header, above 4000 characters, or beyond 60 messages per IP per hour; the chat ticket skips ticket orchestration, so no automations, notifications, auto-replies or embeddings run for it.
POST
/api/{tenant:minlength(2)}/v{version:apiVersion}/chat_bot/start
Request arguments
| Name | Type | Source |
|---|---|---|
| input | DTO_chat_bot_start_input | Body |
Request body example
Response
Response body example
DTO_chat_bot_start_input
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| form_key | String | Form key | |
| message | String | Message | |
| sys_submitted_from | String | Host page url the form is embedded on (same source as the form's sys_submitted_from) |
DTO_chat_bot_response
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| found | Boolean | True when the bot found knowledge and produced a reply. False = show the classic form. | |
| reply | String | ReadOnly | Reply |
| ticket_id | Int32 | The chat session ticket (local id). Set once the first bot reply exists. | |
| session_token | String | Secret session token. Required on follow-up messages, rating and form promotion. | |
| fallback_message | String | ReadOnly | AI-written first-person summary of what the visitor needs (their own language), built from the whole conversation. The widget uses it to pre-fill the classic form's message when the chat falls back to it, so the visitor doesn't have to retype everything. Null when the condense call failed - fall back to the visitor's raw message. |
| fallback_subject | String | ReadOnly | Matching AI-written subject line (visitor's language) for the fallback form. |
Generated Aug 4, 2026 18:37