Developer platform · v2

API reference

View as MarkdownAll docs

Projects API

3 operations · all resources

What this covers#

A project is the isolation boundary: credentials, keys, agents, numbers, sessions and webhooks all belong to exactly one. Create one per environment or per customer.

Every example below runs as written once these are exported:

bash
export DVAARIK_TOKEN="<account access token>"   # console session, from POST /console/auth/login
export PROJECT_ID="<uuid>"

A <value> inside a JSON body is a value you supply. Responses are JSON; every error body is { "detail": … }. Each schema is expanded once per page, where it first appears.

Account door errors#

StatusCause
401No account session was presented, or it is invalid or expired. Refresh once, then re-authenticate.
403The account is suspended or its email is not verified.

Operations — account session#

The same resource through the console door. These are what the web console calls; both doors return the same shapes.

GET /v2/projects#

List the projects on this account.

DetailValue
DoorAccount session — Authorization: Bearer $DVAARIK_TOKEN
Operationlist_projects_v2_projects_get
Success200 ProjectInfo[]
ParameterInTypeRequiredNotes
limitqueryintegerno
offsetqueryintegerno

ProjectInfo#

FieldTypeRequiredNotes
api_rpmintegeryes
created_atdate-timeyes
external_referencestring or nullyes
iduuidyes
is_defaultbooleanyes
max_call_secondsintegeryes
namestringyes
revisionintegeryes
social_daily_sendsintegeryes
social_rpmintegeryes
statusstringyes
updated_atdate-timeyes
voice_concurrencyintegeryes
ErrorWhen
422The request body or query is not valid. detail is an array of {loc, msg, type} and loc names the offending field.

Plus the account-door errors above. Full list on the errors page.

bash
curl -sS -X GET "https://api.developers.dvaarik.com/v2/projects?limit=20" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /v2/projects#

Create a project — the isolation boundary every other resource hangs off.

DetailValue
DoorAccount session — Authorization: Bearer $DVAARIK_TOKEN
Operationcreate_project_v2_projects_post
Success201 ProjectInfo

Request body: CreateProjectRequest.

CreateProjectRequest#

FieldTypeRequiredNotes
external_referencestring or nullno
namestringyes
ErrorWhen
422The request body or query is not valid. detail is an array of {loc, msg, type} and loc names the offending field.

Plus the account-door errors above. Full list on the errors page.

bash
curl -sS -X POST "https://api.developers.dvaarik.com/v2/projects" \
  -H "Authorization: Bearer $DVAARIK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production",
    "external_reference": "acct_4821"
  }'

GET /v2/projects/{project_id}#

Read one project with its concurrency, request-rate and maximum-session limits.

DetailValue
DoorAccount session — Authorization: Bearer $DVAARIK_TOKEN
Operationget_project_v2_projects__project_id__get
Success200 ProjectInfo
ParameterInTypeRequiredNotes
project_idpathuuidyes
ErrorWhen
422The request body or query is not valid. detail is an array of {loc, msg, type} and loc names the offending field.

Plus the account-door errors above. Full list on the errors page.

bash
curl -sS -X GET "https://api.developers.dvaarik.com/v2/projects/$PROJECT_ID" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

Try it without a key in the browser

The playground opens a real voice session with your account session, so a project key never reaches a browser. Machine calls belong on your own server.