BotDesk

Reference

API reference

Every BotDesk API endpoint explained, with its parameters and request and response examples.

Chat

Send messages

Send a message to your bot and get a reply grounded in your knowledge base, with the sources it cited.

View endpoint →

Conversations

Read conversations

List your account's conversations and read the full message history of any one of them.

View endpoint →

Metrics

Read metrics

Get your account's usage metrics — total conversations, messages and averages — in a single request.

View endpoint →

Webhooks

Receiving webhooks

Subscribe a URL and receive signed, real-time events from your bots — new conversations, messages and escalations.

View endpoint →