Skip to main content
The FormBharo REST API exposes 30 endpoints organised across five resource groups. All endpoints are under /api/v1 on your FormBharo server, with the single exception of POST /offer — the WebRTC signalling path, which lives at the bare root.

​
Authentication

Every request must include an Authorization header with your API key:
Four routes are open and require no API key:
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:

​
Resource Groups

Agents

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

Agent Versions

Browse the full version history of any agent and restore a previous version at any time.

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 organisation.

​
Conventions

These supporting reference pages document the patterns that apply across the whole API:
  • API Conventions — request format, content-type requirements, pagination, and date formats.
  • Error Responses — every HTTP error code the API returns, with example payloads and remediation guidance.
  • Known Gotchas — field-name differences between create/update bodies and read-back responses, and other sharp edges to watch for.