Introduction

Build with HeyRik

HeyRik gives you the APIs and building blocks to create, connect, deploy, and improve sophisticated AI voice agents.

8 minute read Practical examples included

A HeyRik agent can answer inbound calls, place outbound calls, follow a structured conversation, use your knowledge, call your APIs, transfer to a person, and return the transcript and outcome to your application.

Start with the job, not the technology.

Define what a successful call should achieve. Then choose the agent, knowledge, number, and integrations needed to achieve it.

How HeyRik works

A call moves through four understandable stages.

Configure the agent

Choose its voice and languages, then define its Conversation Flow and call behavior.

Connect trusted knowledge

Upload documents or add URLs so answers come from approved information.

Connect the call

Assign a number for inbound calls or dispatch an outbound call through the API.

Use the result

Read the transcript, recording, summary, cost, and extracted variables in your application.

The building blocks

Each part has one clear responsibility.

Agent

The AI that speaks and makes decisions during the call.

Real estate qualifier Conversation Flow

Ordered instruction sections that control how the agent behaves.

Ask budget → location → timeline Knowledge base

Approved facts the agent can use when answering questions.

Pricing PDF and refund policy Phone number

The connection used to receive or place calls.

+91 business number Custom API

A tool the agent can call during a conversation.

Check appointment availability Call result

The record your application receives after the call.

Transcript, outcome, and extracted fields

What you can build

The same platform primitives support different industries and outcomes.

AI receptionist

Answer every inbound call, explain opening hours, collect the caller’s intent, book appointments, and route urgent requests.

Lead qualification agent

Call new leads, understand requirements, qualify interest, capture structured fields, and schedule the right follow-up.

Customer support agent

Identify the customer, answer from approved policies, look up information through a custom API, and create a ticket when needed.

Campaign calling agent

Call a list of leads for reminders, surveys, renewals, or outreach, then export outcomes for your workflow.

Create your first agent

This small example creates a support agent. The request defines its identity, opening line, and basic behavior.

Request

curl -X POST https://server.heyrik.com/api/v1/agents \
  -H "Authorization: Bearer $HEYRIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Support Agent",
    "language": "en-IN",
    "greeting": "Hi, thanks for calling Acme. How can I help?",
    "config": {
      "personality": "Friendly",
      "prompt_sections": [
        {
          "order": 0,
          "title": "Identity & Purpose",
          "content": "You are Acme’s support agent. Resolve the caller’s question using approved company information."
        },
        {
          "order": 1,
          "title": "Guardrails",
          "content": "Never invent policy details. If the answer is unavailable, offer a human follow-up."
        }
      ]
    }
  }'

Example output

{
  "data": {
    "id": "agc_9f2a1c30",
    "name": "Support Agent",
    "language": "en-IN",
    "greeting": "Hi, thanks for calling Acme. How can I help?",
    "config": {
      "personality": "Friendly",
      "prompt_sections": [
        { "order": 0, "title": "Identity & Purpose", "enabled": true },
        { "order": 1, "title": "Guardrails", "enabled": true }
      ]
    },
    "created_at": "2026-07-24T06:11:44.201Z"
  }
}

What the call output looks like

After a call finishes, your application can read the outcome and use it in the next workflow.

Completed support call

resolved

Caller+91 98765 43210

Duration3m 42s

OutcomeRefund policy explained

Extracted fieldorder_id: ORD-2048

Next actionNo follow-up required

GET /calls/{id} response

{
  "data": {
    "id": "call_1dd990f7",
    "status": "completed",
    "outcome": "resolved",
    "summary": "Caller asked about the refund window. The agent explained the approved 14-day policy.",
    "extracted_variables": { "order_id": "ORD-2048" },
    "transcript_url": "https://…",
    "recording_url": "https://…"
  }
}

Choose your next step

Continue with the guide that matches what you need to build.