Chat API

8 operations · all resources

What this covers#

Typed chats with an agent, from your web chat or your own app. Start a conversation, then send each message and get the agent's reply in the response. The agent answers with the same job, knowledge and actions as on a call. Each reply costs ₹0.05 or $0.0005 from the wallet; messages from people are free.

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 CHAT_ID="<uuid>"
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: voice:read, voice:write. 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/chats#

List conversations, the most recent message first, filtered by agent or channel.

ChatPage#

ChatInfo#

FieldErrors#

A 422 from a route that names its fields: every field that failed validation, or one sentence when the request validated and was then refused.

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

curl -sS -X GET "https://api.developers.dvaarik.com/v2/chats?limit=20" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

POST /v2/chats#

Start a conversation with an agent. Give variables for the agent's job and your own external_id for the person; nothing is charged until a reply is written.

Request body: ChatCreate.

ChatCreate#

Start a conversation with an agent (the chat API: your web chat, your own app).

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

curl -sS -X POST "https://api.developers.dvaarik.com/v2/chats" \
  -H "X-Api-Key: $DVAARIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "<agent uuid>",
    "external_id": "customer-4821",
    "variables": {
      "company": "Northline Dental"
    }
  }'

GET /v2/chats/{chat_id}#

Read a conversation with its newest messages, oldest first: each reply's status, cost, tokens and actions. Send before (from next_before) to read further back.

ChatDetail#

ChatMessageInfo#

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

curl -sS -X GET "https://api.developers.dvaarik.com/v2/chats/$CHAT_ID?limit=20" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

POST /v2/chats/{chat_id}/messages#

Send the person's message and get the agent's reply in the response. Send an Idempotency-Key; the same key again returns the first reply with duplicate: true and is never charged twice.

Request body: ChatMessageCreate.

ChatMessageCreate#

One message from the person, as text.

ChatExchange#

The person's message and the agent's reply to it. A reply that could not be written is failed, says why in error, and is charged nothing.

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

curl -sS -X POST "https://api.developers.dvaarik.com/v2/chats/$CHAT_ID/messages" \
  -H "X-Api-Key: $DVAARIK_API_KEY" \
  -H "Idempotency-Key: <unique per call attempt>" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Do you open on Sunday?"
  }'

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}/chats#

List conversations, the most recent message first, filtered by agent or channel.

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/chats?limit=20" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /console/v2/projects/{project_id}/chats#

Start a conversation with an agent. Give variables for the agent's job and your own external_id for the person; nothing is charged until a reply is written.

Request body: ChatCreate.

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/chats" \
  -H "Authorization: Bearer $DVAARIK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "<agent uuid>",
    "external_id": "customer-4821",
    "variables": {
      "company": "Northline Dental"
    }
  }'

GET /console/v2/projects/{project_id}/chats/{chat_id}#

Read a conversation with its newest messages, oldest first: each reply's status, cost, tokens and actions. Send before (from next_before) to read further back.

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/chats/$CHAT_ID?limit=20" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /console/v2/projects/{project_id}/chats/{chat_id}/messages#

Send the person's message and get the agent's reply in the response. Send an Idempotency-Key; the same key again returns the first reply with duplicate: true and is never charged twice.

Request body: ChatMessageCreate.

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/chats/$CHAT_ID/messages" \
  -H "Authorization: Bearer $DVAARIK_TOKEN" \
  -H "Idempotency-Key: <unique per call attempt>" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Do you open on Sunday?"
  }'