Everything the Console does, over the API.

Three blocks, and you have a call.

Place a call, receive the webhook, then move the agent definition into version control once you are happy with it. Nothing here needs an SDK.

1 — Place an outbound call

curl -X POST "${NIVAKYA_API_BASE}/v1/calls/dial" \
  -H "Authorization: Bearer ${NIVAKYA_KEY}" \
  -H "Idempotency-Key: 8f2c1a4e-b7d0-4f31-9c22-6a5e0b9b1d44" \
  -H "Content-Type: application/json" \
  -d '{
    "agent": "collections-v4@2026-08-30",
    "to": "+131****4471",
    "from": "+1307****1120",
    "region": "uk-south",
    "consent": { "basis": "prior_express", "captured_at": "2026-08-30T09:12:04Z" },
    "context": { "account_ref": "AC-88213", "balance_bucket": "31-60" }
  }'

A dial request is validated against consent, regional calling windows and your suppression list before it is queued. A rejected request returns 422 with the specific rule that refused it.

2 — Receive the webhook

{
  "id": "evt_01J8QK3W7A2M4T",
  "type": "call.ended",
  "created_at": "2026-09-18T14:22:51Z",
  "workspace": "ws_helpline_retail",
  "region": "uk-south",
  "data": {
    "call_id": "call_01J8QK2R9B",
    "agent": "collections-v4",
    "agent_version": "2026-08-30",
    "started_at": "2026-09-18T14:19:07Z",
    "duration_seconds": 224,
    "outcome": "payment_promise",
    "disposition": "promise_to_pay",
    "escalated": false,
    "turns": 38,
    "chain_verdict": "intact",
    "tool_calls": [
      { "name": "verify_identity", "status": "ok" },
      { "name": "create_promise", "status": "ok", "amount": 184.0 }
    ],
    "recording": { "available": true, "retention_days": 180 },
    "consent": { "basis": "prior_express", "verified": true }
  }
}

3 — Keep the agent in version control

apiVersion: nivakya.dev/v1
kind: Agent
metadata:
  name: collections-v4
  region: uk-south
spec:
  voice:
    language: en-GB
    alternate_languages: [es-US]
    speaking_rate: 1.02
    barge_in: true
  policy:
    rule_set: lending-collections-2026-q3
    fail_mode: escalate
    max_call_minutes: 12
    required_disclosures: [P-114, P-119]
  guardrails:
    - never_quote_below_list
    - verify_identity_before_balance
    - readback_digit_by_digit
  tools:
    - name: verify_identity
      timeout_ms: 1800
    - name: create_promise
      timeout_ms: 2500
  escalation:
    triggers: [caller_asks_for_human, distress_detected, policy_unevaluable]
    warm_transfer_queue: collections-tier2
  rehearsal:
    personas: adversarial-standard
    runs: 10000
    required_pass_rate: 0.995

The same file is accepted by the CLI, by the Studio's import screen and by the API. A publish is refused unless the referenced rehearsal run passed at or above the declared rate.

Fourteen endpoints, no surprises.

Every path is versioned under /v1. Scopes are granted per key and are listed in the Console under Developer → Keys, together with a live call counter for each key.

Usage and billing figures are served from /v1/usage with the same key scopes as the Console's billing screen. Errors follow one shape: an error code, a human sentence, and the field or rule responsible.

Six libraries, one command each.

Client libraries are generated from the same specification as this reference, versioned with the API, and shipped from our own artifact host. The Console's Developer tab prints the install command pinned to your workspace's API version, so nothing in a README can drift out of date.

Published, enforced, and adjustable on request.

Limits are per workspace unless stated otherwise. Every response carries the current window's remaining allowance in headers, and a 429 always includes a retry-after value rather than leaving you to guess.

Sandbox workspaces get one tenth of every limit and a hard ceiling of 200 simulated calls per run. Current p50 and p99 latency for these surfaces is on the status page.

Review an agent the way you review a migration.

An agent definition is a file. It diffs, it reviews, it rolls back. The example below is a real change from a collections deployment: a guardrail added after a caller disclosed a hardship situation that the previous rule set had no branch for.

--- collections-v4@2026-08-30
+++ collections-v4@2026-09-14
@@ spec.policy
   rule_set: lending-collections-2026-q3
   fail_mode: escalate
   max_call_minutes: 12
-  required_disclosures: [P-114]
+  required_disclosures: [P-114, P-119]
@@ spec.guardrails
   - never_quote_below_list
   - verify_identity_before_balance
   - readback_digit_by_digit
+  - hardship_indicator_halts_negotiation
+
@@ spec.escalation.triggers
   - caller_asks_for_human
   - distress_detected
   - policy_unevaluable
+  - hardship_disclosed
@@ spec.rehearsal
   personas: adversarial-standard
   runs: 10000
-  required_pass_rate: 0.990
+  required_pass_rate: 0.995

Six releases, most recent first.