Criyx documentation

Criyx is an AI automation company. We build services that take over repetitive business work, and our main product is voice AI agents: agents that answer and make phone calls for your business, in your words, any hour of the day.

• Answer inbound calls: greet callers, take their name, answer questions and book appointments.
• Make outbound calls: follow-ups, reminders and lead calls, one by one or to thousands of contacts.
• Hand over to a person when the caller asks, or when your instructions say so.
• Remember each caller, and keep a recording and details of every call.

1. Add credits by buying a plan (the 25K or the 50K plan). ₹1 is 1 credit.
2. Create an agent and pick its model: V1, V2 or V3.
3. Write its instructions, choose a voice and language, and add knowledge or tools.
4. Publish. The agent is live and uses your phone number.
5. Receive calls, or start a batch or campaign to call a list of contacts.
6. Watch the dashboard and call history: minutes used, outcomes and recordings.

Calls are billed per minute, rounded up to the next whole minute (1:01 counts as 2 minutes).

The next five sections walk through each flow in detail.

V1 is the quickest way to get a calling agent live, at the lowest price.

1. 1Open Agents and click Create Agent. Type the agent name and choose Criyx V1.
2. 2Pick the Language and the Voice. V1 has one voice.
3. 3Instructions tab: write what the agent is, what it must do and how it should talk.
4. 4Outputs tab (optional): list the details you want back from each call, such as the caller's name or interest. Each one has a key and a short description.
5. 5Memory tab (optional): tell the agent what to remember about the caller.
6. 6Settings: set the greeting (Say hello), whether the caller can interrupt, the maximum call duration, and the voicemail and call-too-long messages.
7. 7Advanced: add a webhook URL to receive call results, and turn on call forwarding with the number to forward to.
8. 8Tools (optional): add the actions the agent can take during the call.
9. 9Save, then use Test Agent to make a test call, inbound or outbound. When it sounds right, go live.

V2 is set up exactly like V1, with premium voices and a faster response.

1. 1Open Agents and click Create Agent. Type the agent name and choose Criyx V2.
2. 2Pick the Language, then choose from all premium voices.
3. 3Fill in Instructions, Outputs and Memory the same way as for V1.
4. 4Use Settings and Advanced for the greeting, interruption, call limits, webhook and call forwarding.
5. 5Add Tools if the agent must do something during the call.
6. 6Run a test call, inbound and outbound, then go live.

V3 opens a full workspace. Each part of the agent has its own tab.

1. 1Open Agents and click Create Agent. Type the agent name and choose Criyx V3. The workspace opens.
2. 2Instructions: write the Greeting first (required), then the role, objective, personality, conversation flow, business rules, dos and don'ts, escalation and call closing.
3. 3Voice: choose the language, or All languages so the agent follows the caller. Open the voice picker to search the 176 voices and filter by gender, language and use.
4. 4Pronunciations (Voice tab): add the words the agent mispronounces, such as a brand or a name, and how to say them. Use the popup to add, edit or delete words, or import and export a CSV or JSON file.
5. 5Knowledge: add the documents and pages the agent should answer from.
6. 6Memory and variables: add variables such as the caller's name and use them in the greeting and instructions.
7. 7Tools and call forwarding: add actions, and set the number to forward to when the caller asks for a person.
8. 8Test Agent: make a test call to check the greeting and the flow.
9. 9Publish. If your inbound number is live, it moves to the new version, so the agent speaks the new instructions.
10. 10Changed something later? Edit, publish again, or use Redeploy.

A batch makes the same agent call a list of contacts. V1 and V2 agents use batches.

1. 1Open Batches and click New Batch/Campaign. Pick the V1 or V2 agent and give the batch a name.
2. 2Upload a CSV with a contact_name column and a contact_phone column.
3. 3Check the result: rows found, valid numbers, invalid numbers and duplicates.
4. 4Settings (optional): timezone, the hours calls start and stop each day, max retries, how long to wait before a retry, and how many calls run at once.
5. 5Start the batch. Open it to watch live progress and each call's details and recording.
6. 6Pause, resume, duplicate or delete a batch from the list.

A campaign is built for V3 agents. It carries each contact's own details into the call.

1. 1Open Campaigns and click New Batch/Campaign. Pick the V3 agent and name the campaign.
2. 2Upload a CSV with contact_name and contact_phone. Any extra column becomes a variable the agent can use.
3. 3Map columns: choose what each column means and its variable key.
4. 4Validate: see the valid, invalid and duplicate numbers before anything is dialled.
5. 5Schedule: pick the timezone, the daily start and stop time, and whether to start now or on a chosen date.
6. 6Retries and concurrency: set max retries (0 means none), the wait before a retry, and how many calls run at once.
7. 7Launch. Follow live progress, answered calls and success rate, and open any call for its recording.

You choose a model per agent. Each one can take both inbound and outbound calls on the same number.

In V3 the instructions page is split into clear parts, so each thing the agent must do has a place. The greeting is required: you cannot publish without it.

Greeting

Required. The first thing the agent says on every call.

Role & objective

Who the agent is and what it must achieve on the call.

Personality

Tone, accent and manner of speaking.

Conversation instructions

The flow of the call, step by step.

Business rules

Hours, prices, appointment rules and anything the agent must follow.

Dos and don'ts

Hard rules the agent always keeps or never breaks.

Escalation & closing

When to hand over to a person and how to end the call.

Variables such as the caller's name can be used inside the instructions and the greeting, for example “Hi {{caller_name}}”. Add them once and the agent fills them in on each call.

• V1 has one voice (Praveshika) and speaks Hindi, English, Punjabi, Bengali, Tamil or Multilingual. V2 includes every premium voice and all 12 languages plus Multilingual.
• V3 offers 176 Criyx V4 voices. The voice picker shows each voice with its gender, the language it is best for and what it was made for (for example Conversational or Customer Support), and has search and filters.
• V3 speaks 12 languages. Pick one language, or choose All languages and the agent follows the caller's language through the call.
• Choose accent and tone in the instructions, for example a Canadian or an American way of speaking.

• Knowledge (V3): add your documents, pages and FAQs. The agent answers from them instead of guessing.
• Memory: the agent remembers the caller and what was said, so a returning caller is not asked again.
• Tools: let the agent do things during the call, such as sending your team the details of an appointment request.

• Inbound: callers dial your number and the agent answers. You can pause and resume inbound at any time.
• Outbound: the agent calls your contacts. Start one call, or use batches and campaigns.
• Redeploy: after you change instructions, publish. The live inbound number is moved to the new version, so the agent speaks the new instructions.
• Additional telephony provider (V3): in the Inbound tab, click Additional telephony provider and send a request. It is available only when the Criyx team approves it. Once approved, you see the one number given to that agent and can add it. Calls on it cost more (see the charge below).
• Silence nudges (V3): in the Voice tab, set what the agent says after the caller has been quiet for a few seconds (up to 5 nudges, in order), and whether to hang up if they still do not answer.
• Voicemail (V3): when an outbound call reaches a voicemail box, the agent leaves your message (up to 1000 characters).
• Call forwarding (V1, V2, V3): turn it on and set the number. When the caller says “connect me to a person”, or your instructions say so, the call is forwarded to that number.
• Test call: try the agent yourself before it goes live, inbound and outbound, on V1, V2 and V3.

Forwarding charge: a V3 agent with call forwarding switched on costs ₹1 extra per minute on every call of that agent, not only the forwarded ones, from the moment you publish it. That is ₹5 per minute on the 50K plan and ₹5.5 per minute on the 25K plan.

External telephony charge: a V3 agent that uses an additional telephony provider costs ₹2 extra per minute, on every call of that agent, starting from the moment you publish the agent with that number. Until then the normal rate applies. The V3 rate goes from ₹4.5 to ₹6.5 per minute on the 25K plan, and from ₹4 to ₹6 per minute on the 50K plan. Agents that do not use it are billed at the normal rate.

• Dashboard and agent summary update as calls finish: calls, minutes, spend and outcomes.
• Every call has its own page with the details and a recording you can play or download.
• Billing shows your credits, plan, 30-day cycle and invoices.

Pay once, get the same amount in credits, use them for 30 days. Unused credits expire after 30 days. Prices are per minute. Rupee prices are exclusive of 18% GST, which is added at payment.

Each agent needs its own number for inbound and outbound calls. A number costs ₹300 for 30 days, you can hold up to 30, and one number serves one agent. Numbers renew by autopay.

Add money that never expires. It is used only when your plan or phone numbers renew, and you always get exactly the credits listed. Rupee prices are exclusive of 18% GST, added at payment.

Phone numbers have their own wallet: top up for at least 3 numbers at ₹300 each. It pays number renewals first, and gives a new agent its number.

Everything you do in the dashboard for a V1, V2 or V3 agent, you can do with the API: create and edit agents, place calls, run batches, read every call with its transcript and recording, read your plan and credits, and get a webhook the moment a call or batch happens. Your customers only ever see your name; Criyx stays behind the API.

curl https://YOUR_API_HOST/api/agents \  -H "Authorization: Bearer YOUR_API_KEY"

# V1: one voice (Praveshika). V2: every premium voice.curl "https://YOUR_API_HOST/api/agents/options?plan=basic" -H "Authorization: Bearer YOUR_API_KEY"curl "https://YOUR_API_HOST/api/agents/options?plan=core"  -H "Authorization: Bearer YOUR_API_KEY"

{  "success": true,  "data": {    "languages": [{ "id": "5192579b-d99c-45b3-8353-5806311ac94d", "name": "Multilingual" }],    "voices": [{ "id": "012f3534-17c4-410f-b62c-c38b1abc6d52", "name": "Mahika (F) - best at Indian English" }]  }}

curl -X POST https://YOUR_API_HOST/api/agents \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "Clinic reception",    "plan": "core",    "languageId": "5192579b-d99c-45b3-8353-5806311ac94d",    "voiceId": "012f3534-17c4-410f-b62c-c38b1abc6d52",    "instructions": "You are the receptionist of Sunrise Clinic. Greet the caller and book appointments.",    "sayHello": true,    "allowInterruption": true,    "maxCallDurationMins": 10,    "allowCallTransfer": true,    "transferDestinationPhone": "9876543210"  }'

{  "success": true,  "data": {    "id": "033ded41-b21c-456d-bbaf-2098f1f21454",    "name": "Clinic reception",    "plan": "core",    "status": "active",    "languageId": "5192579b-d99c-45b3-8353-5806311ac94d",    "voiceId": "012f3534-17c4-410f-b62c-c38b1abc6d52",    "outDid": "918044484499",    "createdAt": "2026-10-19T14:41:33.457141+00:00"  }}

curl -X PATCH https://YOUR_API_HOST/api/agents/AGENT_ID \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "instructions": "New instructions.", "voicemailMsg": "" }'

curl -X POST https://YOUR_API_HOST/api/calls \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: booking-1042" \  -d '{ "agentId": "AGENT_ID", "countryCode": "91", "toNumber": "9876543210" }'

{  "success": true,  "data": {    "criyxCallId": "ac19365a-0f86-4b08-8de0-20020d5ac162",    "message": "Call initiated.",    "agentLocalId": "033ded41-b21c-456d-bbaf-2098f1f21454",    "toNumber": "9876543210",    "countryCode": "91"  }}

curl -X POST https://YOUR_API_HOST/api/batches/contacts/validate \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "contacts": [    { "contact_name": "Asha Verma", "contact_phone": "9876543210" },    { "contact_name": "Ravi Kumar", "contact_phone": "12" }  ] }'

{  "success": true,  "data": {    "rows": 2,    "valid": 1,    "invalid": [{ "row": 2, "field": "contact_phone", "value": "12",      "message": "Phone must be exactly 10 digits (India) or include a country_code." }],    "duplicates": []  }}

curl -X POST https://YOUR_API_HOST/api/batches \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "agentId": "AGENT_ID",    "batchName": "October reminders",    "contacts": [      { "contact_name": "Asha Verma", "contact_phone": "9876543210" },      { "contact_name": "John Smith", "contact_phone": "4165550123", "country_code": "1" }    ],    "settings": {      "schedule": { "days": [1, 2, 3, 4, 5], "start_time": "10:00", "end_time": "18:00", "timezone": "Asia/Kolkata" },      "maxRetries": 2,      "retryAfterHrs": 3,      "maxConcurrentCalls": 2    }  }'

{  "success": true,  "data": {    "id": "5a5491a0-b330-457b-a22e-760552a640ca",    "name": "October reminders",    "status": "Draft",    "totalContacts": 2,    "createdAt": "2026-10-25T23:12:05.321135+00:00"  }}

curl -X POST https://YOUR_API_HOST/api/batches/BATCH_ID/start \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'

curl "https://YOUR_API_HOST/api/calls?agentId=AGENT_ID&batchId=BATCH_ID&status=Completed&page=1&pageSize=25" \  -H "Authorization: Bearer YOUR_API_KEY"

{  "uuid": "ac19365a-0f86-4b08-8de0-20020d5ac162",  "agentLocalId": "033ded41-b21c-456d-bbaf-2098f1f21454",  "agentName": "Clinic reception",  "toNumber": "+919968466342",  "outcome": "Completed",  "startedAt": "2026-10-22T20:26:18.627+00:00",  "endedAt": "2026-10-22T20:28:39.815+00:00",  "durationSeconds": 140,  "hasRecording": true,  "batchId": null,  "billedMinutes": 3,  "creditsUsed": 9}

curl https://YOUR_API_HOST/api/calls/CALL_ID -H "Authorization: Bearer YOUR_API_KEY"

{  "success": true,  "data": {    "criyxCallId": "ac19365a-0f86-4b08-8de0-20020d5ac162",    "contactPhone": "+919968466342",    "outcome": "Completed",    "durationSeconds": 140,    "billedMinutes": 3,    "creditsUsed": 9,    "callOutput": null,    "hasTranscript": true,    "transcript": [      { "role": "assistant", "content": "Hello, this is Sunrise Clinic. May I know your name?" },      { "role": "user", "content": "Hi, I want an appointment." }    ],    "recording": {      "available": true,      "url": "https://YOUR_API_HOST/api/calls/ac19365a-0f86-4b08-8de0-20020d5ac162/audio",      "status": "AVAILABLE"    }  }}

curl https://YOUR_API_HOST/api/calls/CALL_ID/transcript -H "Authorization: Bearer YOUR_API_KEY"

# The link (and its status)curl https://YOUR_API_HOST/api/calls/CALL_ID/recording -H "Authorization: Bearer YOUR_API_KEY"
# The audio itself (supports Range, so a player can seek). Add ?download=1 to get it as a file.curl -o call.wav "https://YOUR_API_HOST/api/calls/CALL_ID/audio?download=1" -H "Authorization: Bearer YOUR_API_KEY"

curl -X POST https://YOUR_API_HOST/api/webhooks/endpoints \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "url": "https://yourapp.com/criyx-events", "events": ["call.completed", "call.failed", "batch.completed"] }'

{  "id": "3f1c0a52-8c1e-4f43-9d0b-6d6a6f1d2a10",  "type": "call.completed",  "createdAt": "2026-10-26T09:41:07.120Z",  "data": {    "callId": "ac19365a-0f86-4b08-8de0-20020d5ac162",    "agentId": "033ded41-b21c-456d-bbaf-2098f1f21454",    "agentName": "Clinic reception",    "toNumber": "+919968466342",    "outcome": "Completed",    "startedAt": "2026-10-26T09:38:41.000Z",    "endedAt": "2026-10-26T09:41:01.000Z",    "durationSeconds": 140  }}

import { createHmac, timingSafeEqual } from "node:crypto";
// rawBody is the request body exactly as received (before JSON.parse).function isFromCriyx(rawBody, signatureHeader, secret) {  const expected = "sha256=" + createHmac("sha256", secret).update(rawBody).digest("hex");  const a = Buffer.from(expected);  const b = Buffer.from(signatureHeader ?? "");  return a.length === b.length && timingSafeEqual(a, b);}

# 1. Create the agent (V3 is plan "premium"). It stays a draft until you publish it.curl -X POST https://YOUR_API_HOST/api/agents \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "name": "Clinic reception", "plan": "premium" }'
# 2. Set it up in its workspace. Send only the parts that change.curl -X PATCH https://YOUR_API_HOST/api/agents/AGENT_ID/workspace \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "config": {      "instructions": {        "role": "You are Riya, the front desk of Sunrise Dental Clinic.",        "objective": "Book appointments and answer questions about fees."      },      "voice": {        "language": "Hindi",        "voice": "Kavya - Conversational Voice",        "greeting": "Namaste, Sunrise Dental Clinic mein aapka swagat hai.",        "maxCallDurationMins": 10      },      "memory": { "enabled": true, "contextTurns": 10 },      "variables": [{ "key": "clinic_city", "value": "Pune", "description": "City of the clinic" }],      "knowledge": { "sources": [{ "id": "fees", "name": "Fees", "type": "text", "content": "Root canal costs 7500 rupees." }] },      "pronunciations": { "Hindi": { "Sunrise": "सनराइज़" } },      "inbound": { "transferEnabled": true, "transferNumber": "9876543210" }    }  }'
# 3. Publish: this is what makes the setup live.curl -X POST https://YOUR_API_HOST/api/agents/AGENT_ID/publish -H "Authorization: Bearer YOUR_API_KEY"

{  "success": true,  "data": { "status": "published", "version": 3, "warnings": [], "message": "Configuration published." }}

curl -X POST https://YOUR_API_HOST/api/agents/AGENT_ID/tools \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "Find booking",    "description": "Looks up a booking by phone number",    "method": "GET",    "url": "https://your-server.example.com/bookings",    "queryParams": [{ "name": "phone", "type": "string", "required": true, "description": "Caller phone" }],    "maxWaitSeconds": 8  }'

curl -X POST https://YOUR_API_HOST/api/calls \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: reminder-1042" \  -d '{    "agentId": "AGENT_ID",    "countryCode": "91",    "toNumber": "9876543210",    "variables": { "clinic_city": "Pune", "contact_name": "Rahul" }  }'

curl -X POST https://YOUR_API_HOST/api/campaigns \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "agentId": "AGENT_ID",    "batchName": "October reminders",    "contacts": [{ "contact_name": "Rahul", "contact_phone": "9876543210", "country_code": "91" }],    "settings": { "maxRetries": 2, "maxConcurrentCalls": 5, "startAt": "2026-11-02T10:00:00+05:30" }  }'
# Stop it at any time (this ends the campaign)curl -X POST https://YOUR_API_HOST/api/campaigns/CAMPAIGN_ID/stop -H "Authorization: Bearer YOUR_API_KEY"

{  "success": false,  "error": {    "code": "REVIEW_REQUIRED",    "message": "Publishing needs a quick review by the Criyx team first. Please contact Criyx support to publish your instructions."  }}