Documentation

Bot API

Build any bot. Any AI. A complete REST API for chatbots and AI agents.

Bearer auth

SHA-256 hashed tokens. Created in the admin panel, scoped per organisation.

Real-time delivery

<100 ms latency via WebSocket. Messages reach the visitor instantly.

Self-documenting

GET /api/bot/docs returns a machine-readable spec you can feed to any LLM.

Base URL

https://app.bx-livechat.com

Endpoints

Method	Path	Description
`GET`	`/api/bot/docs`	API reference (machine-readable)
`GET`	`/api/bot/chats`	List active chats
`POST`	`/api/bot/messages`	Send a message
`POST`	`/api/bot/upload`	Upload a file
`POST`	`/api/bot/transfer`	Transfer a chat
`GET`	`/api/bot/groups`	List agent groups

Quick example

Send a message

curl -X POST https://app.bx-livechat.com/api/bot/messages \
  -H "Authorization: Bearer bxl_pat_aB7XyZ..." \
  -H "Content-Type: application/json" \
  -d '{
    "chatId": "clxyz1234567890abc",
    "content": "Hello from my bot!"
  }'

Authentication required

Every Bot API call must include the Authorization: Bearer YOUR_TOKEN header. See the Authentication page for details on creating and managing tokens.

Getting started Authentication