Skip to main content
The FormBharo REST API is organized into resource groups: Agents, Calls, Analytics, and Workspaces. All endpoints are under /api/v1 on your FormBharo server, with one exception: POST /offer, the WebRTC signalling path, which lives at the bare root.

​
Authentication

Every request must include an Authorization header with your API key. See API keys for how to create one.
Running a call from your own page needs no key: POST /api/v1/conversations returns a conversation id and a token, and that token authorizes the audio connection and the answer poll. See Run a call.
Keep your API key secret. Never embed it in client-side JavaScript or expose it in a public repository. Rotate it immediately if it is compromised.

​
Base URL

Every example in this reference uses this address.
All API paths are then appended after this base. For example:

​
Errors

A 403 or a 404 carries the reason in an error field.
A key belongs to one workspace. A request for an agent or a workspace outside it returns 404, the same as an id that does not exist.

​
Resource groups

Agents

Create, read, update, delete, and publish agents. Manage access lists and move agents between workspaces

Calls

Read conversations, retrieve collected answers, and download full call transcripts

Analytics

Query completion rates, average call duration, and per-agent cost breakdowns

Workspaces

Manage workspace membership, roles, and settings across your organization