CLI

Install

npx vaakyo --help          # run without installing
npm install -g vaakyo      # or install it (Node 18 or later)

Sign in

Create an API key in the console (Settings > API keys), then either export it or save it:

export VAAKYO_API_KEY=vx_...
vaakyo login               # asks for the key and saves it in ~/.config/vaakyo/config.json
vaakyo whoami

Commands

Command	What it does
vaakyo agents list	Your agents
vaakyo agents get <agent_id>	One agent
vaakyo call <agent_id> <phone> [--data key=value ...]	Place a call; --data becomes user_data for the agent’s {variables}
vaakyo calls list [--agent <id>] [--status <s>] [--limit <n>]	Recent calls
vaakyo calls get <call_id> [--transcript]	A call with its summary and transcript
vaakyo calls hangup <call_id>	End a live call
vaakyo numbers list	Your phone numbers
vaakyo balance	Credits and plan
vaakyo api <METHOD> <path> [--body '{...}']	Any /api/v1 endpoint

Phone numbers without a country code are taken as Indian (9800000000 becomes +919800000000).

vaakyo call agt_123 9800000000 --data name=Rohan --data order=KF-1042
vaakyo calls get call_456 --transcript
vaakyo api GET "/calls?status=completed&limit=5" --json | jq '.items[].id'

Exit codes

0 success, 1 an error (the message is printed), 2 the key is missing, invalid or lacks the permission. On 429 the CLI prints how long to wait.