API reference

A REST API is on the way.

We're building a public REST API, outbound webhooks, and official SDKs. They aren't generally available yet — today you integrate Praatbox through the embed widget. Want early access? Email support@praatbox.com.

Available today

Planned public API (preview)

The shapes below — along with outbound webhooks — are a preview of the planned v1 REST API. They are not live yet and may change before release.

# Preview — not live yet
curl https://api.praatbox.com/v1/conversations \
  -H "Authorization: Bearer pk_live_..."
  • GET /v1/conversations — list conversations, with cursor pagination and status filtering.
  • GET /v1/conversations/:id — a single conversation with full transcript and handoff metadata.
  • POST /v1/conversations/:id/messages — post an agent message into a thread.
  • POST /v1/knowledge/sources — add a knowledge source.
  • GET /v1/analytics — KPI counters: conversation volume, deflection rate, top intents.

Planned SDKs

Official SDKs for TypeScript/JavaScript, Python, Ruby, and Go are planned to ship alongside the public API. Want to be notified? Let us know.