Skip to main content
POST
GET Widget Chat

Send chat message

POST /api/widget/chat Public API endpoints for the embeddable chat widget.
These endpoints do not require authentication. They are designed for use by the JavaScript widget on your website.

Body parameters

integer
required
Site ID.
string
Existing conversation ID, or null to start a new conversation.
string
required
Chat message from the visitor.
object
Visitor contact information (name, email, phone).

Request human agent

POST /api/widget/request-agent

Body parameters

string
required
Conversation ID to escalate.
string
Reason for requesting a human agent.

Get conversation history

GET /api/widget/conversation/:conversationId
string
required
Conversation ID.

Save contact from widget

POST /api/widget/contacts

Body parameters

integer
required
Site ID.
string
Visitor name.
string
Visitor email.
string
Visitor phone number.

Get widget config

GET /api/widget/config/:siteId
integer
required
Site ID.
Returns widget appearance and behavior settings.

Get knowledge base

GET /api/widget/kb/:siteId
integer
required
Site ID.
Returns knowledge base articles for the widget.

Get Q&A pairs

GET /api/widget/qa/:siteId
integer
required
Site ID.
Returns Q&A pairs for the widget.

Get article

GET /api/widget/article/:articleId
integer
required
Article ID.
Returns a single knowledge base article.