Projects API

7 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. Its zero retention switch decides whether it stores any conversation content, and "delete stored conversations" removes what it stored before.

Every example below runs as written once these are exported:

export DVAARIK_API_KEY="dvk_..."        # project API key, server side only
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.

Machine door errors#

Raised by the project-key dependency before any handler on this page runs.

Scopes used on this page: project:read. Mint a key with only these.

Account door errors#

Operations — project API key#

Call these from your own server with a project key. Never from a browser or a mobile bundle.

GET /v2/project/retention#

Read the project's zero retention: whether it is on, who changed it and when (the console door only; the machine door leaves out who), every recorded change, and what is kept right now, in words.

ProjectRetentionInfo#

The project's zero-retention switch, its history and what is kept.

RetentionChange#

One change of the switch: to what, when, by whom, on which door. user_id and email are null on the machine door (any key with project:read reads it); the console shows them.

RetentionChangedBy#

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

curl -sS -X GET "https://api.developers.dvaarik.com/v2/project/retention" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

Operations — account session#

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

GET /console/v2/projects/{project_id}/retention#

Read the project's zero retention: whether it is on, who changed it and when (the console door only; the machine door leaves out who), every recorded change, and what is kept right now, in words.

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

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

PUT /console/v2/projects/{project_id}/retention#

Turn zero retention on (it applies to calls, chats and test runs that start from now on) or off. Off needs confirm_turn_off: true; without it the answer is a 422 sentence and nothing changes. Every change is recorded with who and when.

Request body: ProjectRetentionUpdate.

ProjectRetentionUpdate#

Turn zero retention on or off. Off needs confirm_turn_off: true: new calls and chats can then store content again, as their agents are set up.

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

curl -sS -X PUT "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/retention" \
  -H "Authorization: Bearer $DVAARIK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "zero_retention": true
  }'

POST /console/v2/projects/{project_id}/stored-conversations/delete#

Delete the project's stored conversation content in one bounded pass: transcripts, summaries, recording references, chat messages, test runs' chats, hand-off reasons and stored webhook bodies. Call again at once while progress is true; after retry_after_seconds when a pass changed nothing because what is left is in use. done is true only when nothing is left. Call records and billing stay.

StoredConversationsDeleted#

One bounded pass of "delete stored conversations". done is true only when nothing of the project's stored conversation content is left. Call again while it is false: at once while progress is true; after retry_after_seconds when a pass could change nothing because everything left was busy (skipped).

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

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/stored-conversations/delete" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

GET /v2/projects#

List the projects on this account.

ProjectInfo#

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

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.

Request body: CreateProjectRequest.

CreateProjectRequest#

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

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.

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

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