Authentication

Verify API key

Validate an API key and confirm which project it belongs to. Send your key in the X-API-Key header; on success the endpoint echoes back the key id, the owning user id, the project (workspace) id the key is scoped to, and when it was created. Use it as a connectivity/auth smoke test before calling any other endpoint.

GET

https://api.nabrah.ai/api/ext/test

Verify API key

curl --request GET \
  --url 'https://api.nabrah.ai/api/ext/test' \
  --header 'X-API-Key: <your-api-key>'

// No example body for this response.

Authentication — start here

Every /api/ext endpoint authenticates the same way. This endpoint is the quickest way to confirm your setup works.

Get a key

In the dashboard open the workspace, go to the Developers tab, and generate a Web API key. The full key (prefixed nb_) is shown once at creation — copy and store it securely. Generate an Embed key instead only for browser/front-end use.

X-API-Key

Send the key

Pass it on every request as the header X-API-Key: nb_xxxxxxxxxxxxxxxxxxxx. There is no project_id parameter anywhere in this API — the key is bound to exactly one project/workspace, and that scope is derived from the key automatically.

X-API-Key

Interpret the result

200 with status "success" means the key is valid; the returned project_id tells you which workspace you are acting on. 401 means the key is missing or invalid.

Base URL: https://api.nabrah.ai/api — so the full URL for this call is https://api.nabrah.ai/api/ext/test

Where to go next

Common first calls once your key is verified:

List voices

GET /api/ext/tts/voices — the voice ids used for text-to-speech and for an agent’s voice.

List agents

GET /api/ext/agent — the agents available in this project and their ids.

List tools

GET /api/ext/tool — function-calling tools you can attach to agents.

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Response

200

Successful Response

application/json