API reference

Base URL: https://api.arivox.dev/v1. Authenticate with a bearer token.

Authorization: Bearer $ARIVOX_KEY

Create a call

POST /v1/calls

Field	Type	Description
to	string	E.164 destination number (outbound).
from	string	Your Arivox or BYO number.
character	string	Character (agent) id.
language	string	he, ar, ar-gulf, ru, en, …
voice	string	Voice id (optional).
languages	string[]	Enable code-switching (optional).
knowledge_base	string	Knowledge base id to ground answers (optional).
tools	string[]	Tool ids the agent may call (optional).
webhook	string	URL for call events (optional).

{
  "id": "call_8f2...",
  "status": "queued",
  "to": "+972543095860",
  "language": "he"
}

Webhook events

Sent to your webhook as the call progresses:

• call.started, call.ended
• transcript.partial, transcript.final
• analysis.extracted — structured fields you defined
• outcome — e.g. booked, resolved, voicemail

{
  "type": "transcript.final",
  "call_id": "call_8f2...",
  "role": "agent",
  "text": "סגרתי לך תור ליום חמישי ב-10:30"
}

SDKs

npm install @arivox/sdk     # TypeScript / Node
pip install arivox          # Python

info

This reference is a scaffold mirroring the planned API surface. Endpoints and fields are finalized as the platform ships — see the plan.