API reference
Introduction
Base URL
Every endpoint in this reference is served from one base URL over HTTPS. Requests and responses are JSON unless an endpoint says otherwise, such as file uploads and generated audio.
https://api.nabrah.ai/apiAuthentication
Send your workspace API key in the X-API-Key header on every request. A key belongs to one workspace, so it only reaches that workspace’s agents, calls and conversations. Create and rotate keys in the dashboard under API keys, keep them out of public code and repositories, and rotate a key straight away if it leaks.
X-API-Key: <your-api-key>Make your first request
- 1
Create an API key
In the Nabrah dashboard, open API keys and create a key for your workspace. It is shown once, so store it somewhere safe.
- 2
Verify it
Call the verify endpoint with the key. A
200response confirms the key and shows which workspace it belongs to.Requestcurl --request GET \ --url 'https://api.nabrah.ai/api/ext/test' \ --header 'X-API-Key: <your-api-key>'Verify API key200{ "status": "success", "message": "API key is valid", "key_details": { "id": "7c0d3f0e-2a52-4b8e-9d3c-5f0e7f4a1b2c", "user ID": "0b6f1c0a-3d9e-4c11-8f5e-2e7a9d1c4b6f", "project_id": "5e2a9c7d-1f4b-4e8a-a3c6-9d0b2f7e8c1a", "created_at": "2026-01-15T12:00:00.000Z" } } - 3
Build on it
Create an agent, connect a number, and place a call, or start with speech: generate audio or transcribe a file.
Errors
Errors use standard HTTP status codes with a JSON body. The detail field says what went wrong: a message for most errors, and a list of problems for validation errors.
The request worked. 204 responses have no body.
The X-API-Key header is missing, or the key is invalid or revoked.
The resource does not exist in the workspace your key belongs to.
The request failed validation. Each item in detail names the field (loc) and the problem (msg).
Something failed on our side. Retry with backoff; contact support if it continues.
{
"detail": [
{
"loc": [
"body",
"agent_id"
],
"msg": "Field required",
"type": "missing"
}
]
}Endpoints
Endpoints are grouped by what they work on. Each page documents its parameters and responses, with samples in cURL, Python, JavaScript and Go, and a playground to send real requests.
Get started
Voice agents
Calls
Telephony
Speech
Inbox
For AI assistants
Every page of the docs has a Markdown version: add .md to its URL. The full reference is also listed in llms.txt, and in full in llms-full.txt, so coding assistants can read it directly. For coding agents that build an integration, SKILL.md is a step-by-step guide they can follow.