Dvaarik
Menu
Get a key

Developer platform · v2

Reference

View as MarkdownAll docs

API reference

One page per resource#

Generated from the backend's published OpenAPI document — regenerate with npm run api:reference, and npm run test:contract fails when it drifts. Each page lists every operation with its door, parameters, request and response fields, declared errors, and a runnable curl example.

ResourceOperationsWhat it is for
Projects API3A project is the isolation boundary: credentials, keys, agents, numbers, sessions and webhooks all belong to exactly one.
API keys3Project-scoped machine keys.
Provider accounts13Your own AI credentials, encrypted per project.
Agents API12An agent is the frozen configuration a call runs against: pipeline, prompt, language, limits and webhook.
Voice sessions8One session is one call.
Carriers and numbers22Bring your own telephony account.
Webhooks API10Signed, retried event delivery per project.
Billing API7A prepaid USD wallet per account.

Every operation#

Projects API#

MethodPathDoorScope
GET`/v2/projects`account session—
POST`/v2/projects`account session—
GET`/v2/projects/{project_id}`account session—

API keys#

MethodPathDoorScope
GET`/v2/api-keys`account session—
POST`/v2/api-keys`account session—
DELETE`/v2/api-keys/{key_id}`account session—

Provider accounts#

MethodPathDoorScope
GET`/v2/provider-accounts`project keyprovider_account:read
POST`/v2/provider-accounts`project keyprovider_account:write
DELETE`/v2/provider-accounts/{account_id}`project keyprovider_account:write
GET`/v2/provider-accounts/{account_id}`project keyprovider_account:read
POST`/v2/provider-accounts/{account_id}/probe`project keyprovider_account:write
POST`/v2/provider-accounts/{account_id}/rotate`project keyprovider_account:write
GET`/console/v2/projects/{project_id}/provider-accounts`account session—
POST`/console/v2/projects/{project_id}/provider-accounts`account session—
DELETE`/console/v2/projects/{project_id}/provider-accounts/{account_id}`account session—
GET`/console/v2/projects/{project_id}/provider-accounts/{account_id}`account session—
POST`/console/v2/projects/{project_id}/provider-accounts/{account_id}/probe`account session—
POST`/console/v2/projects/{project_id}/provider-accounts/{account_id}/rotate`account session—
GET`/v2/provider-catalog`account session—

Agents API#

MethodPathDoorScope
GET`/v2/agents`project keyvoice:read
POST`/v2/agents`project keyvoice:write
DELETE`/v2/agents/{agent_id}`project keyvoice:write
GET`/v2/agents/{agent_id}`project keyvoice:read
PATCH`/v2/agents/{agent_id}`project keyvoice:write
POST`/v2/agents/{agent_id}/rotate-secret`project keyvoice:write
GET`/console/v2/projects/{project_id}/agents`account session—
POST`/console/v2/projects/{project_id}/agents`account session—
DELETE`/console/v2/projects/{project_id}/agents/{agent_id}`account session—
GET`/console/v2/projects/{project_id}/agents/{agent_id}`account session—
PATCH`/console/v2/projects/{project_id}/agents/{agent_id}`account session—
POST`/console/v2/projects/{project_id}/agents/{agent_id}/rotate-secret`account session—

Voice sessions#

MethodPathDoorScope
GET`/v2/voice/sessions`project keyvoice:read
POST`/v2/voice/sessions`project keyvoice:write
GET`/v2/voice/sessions/{session_id}`project keyvoice:read
POST`/v2/voice/sessions/outbound`project keyvoice:write
GET`/console/v2/projects/{project_id}/voice/sessions`account session—
POST`/console/v2/projects/{project_id}/voice/sessions`account session—
GET`/console/v2/projects/{project_id}/voice/sessions/{session_id}`account session—
POST`/console/v2/projects/{project_id}/voice/sessions/outbound`account session—

Carriers and numbers#

MethodPathDoorScope
GET`/v2/carriers`project keycarrier:read
POST`/v2/carriers`project keycarrier:write
DELETE`/v2/carriers/{connection_id}`project keycarrier:write
GET`/v2/carriers/{connection_id}`project keycarrier:read
POST`/v2/carriers/{connection_id}/numbers`project keycarrier:write
POST`/v2/carriers/{connection_id}/numbers/import`project keycarrier:write
POST`/v2/carriers/{connection_id}/verify`project keycarrier:write
GET`/v2/carriers/catalog`project keycarrier:read
GET`/v2/carriers/numbers`project keycarrier:read
DELETE`/v2/carriers/numbers/{number_id}`project keycarrier:write
PATCH`/v2/carriers/numbers/{number_id}`project keycarrier:write
GET`/console/v2/projects/{project_id}/carriers`account session—
POST`/console/v2/projects/{project_id}/carriers`account session—
DELETE`/console/v2/projects/{project_id}/carriers/{connection_id}`account session—
GET`/console/v2/projects/{project_id}/carriers/{connection_id}`account session—
POST`/console/v2/projects/{project_id}/carriers/{connection_id}/numbers`account session—
POST`/console/v2/projects/{project_id}/carriers/{connection_id}/numbers/import`account session—
POST`/console/v2/projects/{project_id}/carriers/{connection_id}/verify`account session—
GET`/console/v2/projects/{project_id}/carriers/catalog`account session—
GET`/console/v2/projects/{project_id}/carriers/numbers`account session—
DELETE`/console/v2/projects/{project_id}/carriers/numbers/{number_id}`account session—
PATCH`/console/v2/projects/{project_id}/carriers/numbers/{number_id}`account session—

Webhooks API#

MethodPathDoorScope
GET`/v2/projects/{project_id}/webhooks`project keywebhook:read
POST`/v2/projects/{project_id}/webhooks`project keywebhook:write
DELETE`/v2/projects/{project_id}/webhooks/{endpoint_id}`project keywebhook:write
POST`/v2/projects/{project_id}/webhooks/{endpoint_id}/test`project keywebhook:write
GET`/v2/projects/{project_id}/webhooks/dead-letters`project keywebhook:read
GET`/console/v2/projects/{project_id}/webhooks`account session—
POST`/console/v2/projects/{project_id}/webhooks`account session—
DELETE`/console/v2/projects/{project_id}/webhooks/{endpoint_id}`account session—
POST`/console/v2/projects/{project_id}/webhooks/{endpoint_id}/test`account session—
GET`/console/v2/projects/{project_id}/webhooks/dead-letters`account session—

Billing API#

MethodPathDoorScope
GET`/console/v2/billing/invoices`account session—
GET`/console/v2/billing/invoices/{invoice_id}.pdf`account session—
GET`/console/v2/billing/quote`account session—
GET`/console/v2/billing/rate`account session—
GET`/console/v2/billing/summary`account session—
POST`/console/v2/billing/topup`account session—
GET`/console/v2/billing/transactions`account session—

Conventions#

  • Origin: https://api.developers.dvaarik.com.
  • Machine door: X-Api-Key: $DVAARIK_API_KEY, from a trusted server only.
  • Account door: Authorization: Bearer $DVAARIK_TOKEN, the console session.
  • Money is an integer nano-USD decimal string; parse it with BigInt, never Number.
  • Every error body is { "detail": … }; see the errors page.
  • There is no SDK yet. The examples are curl, fetch, and requests.
  • To try a call without writing code, use the playground rather than pasting a key into a browser.

Use one project per boundary

Provider secrets stay encrypted and project API keys stay on your server.

Open ProjectsConnect providers