Skip to main content
To start using the Public API, an organization administrator must create a scoped API key in Brightalk API settings before requests can authenticate. A valid request must use an active organization key, a documented API version and scope, eligible dashboard resources, and supported destination routing.

​
Available functionality

  • Create, retrieve, list, and update organization contacts within the documented fields.
  • List eligible AI voice agents and summaries of dashboard-managed Automations.
  • Queue, retrieve, list, and cancel immediate asynchronous AI calls.
  • Create a batch draft for up to 1,000 unique recipients; start or schedule it; inspect aggregate state; pause, resume, or cancel it.
  • Create an Automation run from an active Automation for one contact; list, retrieve, and cancel the run.
  • Retrieve the documented scalar statuses, answer classifications, outcomes, summaries, durations, timestamps, and aggregate batch counts.
  • Retrieve independently revisioned call summaries with calls:read, and paginate a cursor-pinned transcript revision with transcripts:read.
  • List call recordings with recordings:read and obtain short-lived download URLs.
Only the operations and fields in the OpenAPI contract are part of this availability statement.

​
Dashboard dependencies

  • Create, expire, rotate, and revoke scoped bt_live_ keys in Brightalk Settings.
  • Configure and maintain AI voice agents in the dashboard; the API catalog is read-only.
  • Configure and activate Automations in the dashboard; the API exposes summaries and runs, not definition editing.
  • Maintain verified destination routing before execution.

​
Explicitly unsupported functionality

The following functionality is currently unsupported:
  • Brightalk SDKs.
  • Customer webhook delivery or replay.
  • A sandbox or dry-run environment.
  • An API logs UI.
  • Streaming playback endpoints or permanent URLs for recordings.
  • Prerecorded-only calls.
  • /v1 paths.
This list states the current boundary and does not imply a release commitment.

​
Pricing and sales

API usage follows the commercial terms that apply to your Brightalk organization. See Brightalk pricing or contact Brightalk for plan-specific questions.