Skip to main content

REST API

Base URL: https://api.dialogbrain.com

Authentication​

All requests require an API key:

X-API-Key: db_live_YOUR_KEY_HERE

See Authentication for details.

Pagination​

List endpoints accept limit (default 50, max 200) and offset query parameters.

GET /api/v1/conversations?limit=20&offset=40

See Pagination for response formats.

Error Format​

All errors are returned as JSON objects:

{
  "detail": "Human-readable description of what went wrong"
}

Validation errors (422) return detailed field-level information:

{
  "detail": [
    {
      "loc": ["body", "agent_id"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

See Error Handling for all status codes and examples.

API Reference​

The full endpoint reference below is organized by resource. Click any section to view available operations, request/response formats, and examples.

Resources​

  • Agents — Create, configure, and manage AI agents
  • Calls — Place calls, retrieve transcripts and recordings
  • Conversations — List and retrieve conversations across all channels
  • Contacts — Manage contacts and discover new ones
  • Messages — Send messages across channels
  • Webhooks — Subscribe to events like message arrival and call completion
  • Billing — Check account balance and transaction history
  • Prompt Blocks — Retrieve and manage agent prompt templates
  • Handoff — Trigger handoffs between agents and humans
  • Search — Full-text search across messages and conversations

About Response Examples​

For now, response bodies are shown by example in the guide pages (see Quickstart and Pagination). Full response schemas are coming soon.

See also: Quickstart, Guides