Authentication
curl https://api.praatbox.com/v1/conversations \ -H "Authorization: Bearer pk_live_4f9c2a..."
GET /v1/conversations
List conversations. Supports cursor pagination via ?cursor= and filtering via ?status=open|resolved.
GET /v1/conversations/:id
Retrieve a single conversation with full transcript, AI confidence scores per turn, and handoff metadata.
POST /v1/conversations/:id/messages
Send a message into the thread on behalf of an agent. Triggers webhook delivery to all subscribed endpoints.
POST /v1/knowledge/sources
Add a knowledge source (URL, sitemap, or upload). The crawler picks it up within 60 seconds.
GET /v1/analytics
Retrieve KPI counters: conversation volume, deflection rate, top intents. Aggregated by hour, day, or week.
Rate limits
1,000 requests / minute per workspace. Bursts up to 2,000. Headers X-RateLimit-Remaining and X-RateLimit-Reset on every response. We return 429 with a Retry-After header when you exceed the limit.
SDKs
- TypeScript / JavaScript —
npm install @praatbox/sdk - Python —
pip install praatbox - Ruby —
gem install praatbox - Go —
go get github.com/praatbox/praatbox-go