Developer API
Build on BotDesk
A simple REST API to talk to your bots, read history, measure usage and receive real-time events. From Zapier, Make or your own backend.
Get started in 30 seconds
- 01
Generate your API key
From the BotDesk dashboard, under Settings → API. The key identifies your account on every request.
- 02
Authenticate every request
Send the key in the X-API-Key header. All endpoints live under /public/v1.
- 03
Send your first message
A POST to /chat returns the bot's reply, its sources and the request metrics.
Request
curl https://api.yepbrain.com/v1/public/v1/chat \
-H "X-API-Key: $BOTDESK_API_KEY" \
-H "Content-Type: application/json" \
-d '{"message": "What are your opening hours?"}'Response
{
"conversation_id": "a3f1c2e0-...",
"response": "We're open Monday to Friday, 9am to 6pm.",
"sources": [{ "filename": "opening-hours.pdf", "score": 0.94 }],
"tokens_used": 312,
"latency_ms": 840
}