# HeyRik Docs

> Official HeyRik documentation for building AI voice agents, integrating the public API, and working with text agents and chat widgets.

Website: https://www.heyrik.com/. Dashboard: https://www.heyrik.com/assistants. Documentation: https://docs.heyrik.com.

Public API base URL: https://server.heyrik.com/api/v1. API requests use Authorization: Bearer $HEYRIK_API_KEY. Keep API keys on your server.

These Markdown files are generated from the documentation and the canonical API reference. Each file includes its original page URL for citation. Examples contain sample values; endpoint notes describe restrictions and availability. Dashboard tutorials and public API operations are distinct workflows.

## Start here

- [Start here](https://docs.heyrik.com/introduction/index.md): Understand HeyRik and choose the right learning path.
- [Get an API key](https://docs.heyrik.com/guides/api-key/index.md): Create, secure, and test an API key.
- [Connect your backend](https://docs.heyrik.com/guides/integrate-backend/index.md): Base URL, auth, the results webhook, the live-leads webhook, and how lead fields reach the agent.
- [HeyRik API Reference](https://docs.heyrik.com/api-reference/index.md): Complete HeyRik API reference with authentication, AI agent creation, knowledge, phone numbers, calls, voices, campaigns, parameters, requests, and response examples.

## Build agents

- [Plan your agent](https://docs.heyrik.com/guides/plan-agent/index.md): Define one useful job, the information it needs, and what a successful call should produce.
- [Write agent instructions](https://docs.heyrik.com/guides/conversation-flow/index.md): Design a structured, reliable conversation.
- [Design with AI](https://docs.heyrik.com/guides/design-with-ai/index.md): Generate and review an agent configuration.
- [Configure the builder](https://docs.heyrik.com/guides/configure-agent/index.md): Open your agent in the dashboard and review its six builder areas. Keep it in Draft while you configure and test.
- [Choose a voice](https://docs.heyrik.com/guides/choose-voice/index.md): Choose a voice that is clear in the caller’s language, then test it with the words your agent will actually say.
- [Add knowledge](https://docs.heyrik.com/guides/knowledge/index.md): Give your agent an approved source of facts and verify how it handles questions the source cannot answer.
- [Connect your tools](https://docs.heyrik.com/guides/connect-tools/index.md): Let the agent take a specific action through a working integration, with clear inputs and an honest failure response.
- [Test and launch](https://docs.heyrik.com/guides/test-and-launch/index.md): Test the saved agent in Draft, inspect the results, and introduce a small amount of controlled traffic.
- [Improve from calls](https://docs.heyrik.com/guides/improve/index.md): Use real call evidence to find a specific problem, make a focused change, and verify that it helped.

## API resources

- [Agents](https://docs.heyrik.com/api-reference/agents/get-agents-list-every-agent-on-your-account/index.md): An agent is the AI that speaks on a call. You define its behaviour as an ordered Conversation Flow (config.prompt_sections) — the same structured sections the dashboard builder uses — plus a voice, languages and call settings. Create one, then point a phone number at it or dial out with it. All 6 operations are linked from the API reference.
- [Knowledge base](https://docs.heyrik.com/api-reference/knowledge/post-agents-id-knowledge-upload-a-pdf/index.md): Give an agent documents to answer from — a price list, a policy page, an FAQ. It quotes these instead of improvising. All 4 operations are linked from the API reference.
- [Phone numbers](https://docs.heyrik.com/api-reference/phone-numbers/get-phone-numbers-list-your-numbers/index.md): List your numbers and choose which agent answers each one. Buying a number needs completed KYC and happens in the dashboard. All 5 operations are linked from the API reference.
- [Calls](https://docs.heyrik.com/api-reference/calls/post-calls-dispatch-place-an-outbound-call/index.md): Dial out with an agent, then read back the transcript, recording, outcome and what it cost. All 4 operations are linked from the API reference.
- [Custom APIs (integrations)](https://docs.heyrik.com/api-reference/custom-apis/post-custom-apis-register-an-endpoint-as-an-agent-tool/index.md): Register your own endpoint as a tool the agent can call mid-conversation — look up an order, check availability, create a ticket. All 4 operations are linked from the API reference.
- [Voices](https://docs.heyrik.com/api-reference/voices/get-voices-list-voices-library-or-your-clones/index.md): Browse the voice library, list your cloned voices, preview one, or clone a new voice from a short recording. A voice's id goes into voice_settings.voice_id on any agent. All 3 operations are linked from the API reference.
- [Campaigns (bulk calling)](https://docs.heyrik.com/api-reference/campaigns/get-campaigns-list-campaigns-with-live-counts/index.md): Call a list of leads with one agent. Seed from a CSV/XLSX or push leads in live, then start, pause and export results. A campaign is continuous: leads that arrive after it has finished are dialled automatically. Every lead field is matched to the agent's input variables by meaning (AI), so a column called "Decision Maker" fills {{prospect_name}} without renaming. Each finished call can be POSTed to your webhook_url — see the Connect your backend guide. All 13 operations are linked from the API reference.
- [Analytics](https://docs.heyrik.com/api-reference/analytics/get-analytics-call-performance-totals-per-agent-per-day/index.md): The numbers a dashboard is built around — calls made and connected, answer rate, talk time — overall, per agent, and as a daily series. All 3 operations are linked from the API reference.
- [Agent settings](https://docs.heyrik.com/api-reference/agent-settings/get-providers-the-managed-speech-language-stack-by-tier/index.md): What the builder UI fills its pickers from — the supported languages and performance tiers. Read these instead of hardcoding lists, so your dashboard never drifts from ours. All 6 operations are linked from the API reference.
- [CRM — leads & folders](https://docs.heyrik.com/api-reference/crm/get-leads-list-leads/index.md): A lead pipeline you can drive entirely from your own app: import contacts, move them through stages, and dial them. All 13 operations are linked from the API reference.
- [Chat (text agents)](https://docs.heyrik.com/api-reference/chat/get-chat-config-chat-pricing-whether-transcripts-are-stored/index.md): Talk to an agent over TEXT — no phone call, no speech. Use a one-shot completion for a quick answer, or a stateful session that remembers the whole conversation. Billed per message (much cheaper than a call), so it's ideal for testing an agent's brain or powering a chatbot in your own product. Same agents as your calls — an agent id from POST /agents works here directly. All 8 operations are linked from the API reference.
- [Chat widgets](https://docs.heyrik.com/api-reference/widgets/get-widgets-list-your-widgets/index.md): Embed a text agent on your own website. Create a widget, drop its snippet in, and those conversations arrive alongside your calls. All 5 operations are linked from the API reference.
- [Account & balance](https://docs.heyrik.com/api-reference/account/get-me-the-account-this-key-belongs-to/index.md): Who the key belongs to, and how many credits are left — check this before starting a large campaign. All 3 operations are linked from the API reference.

## Academy

- [HeyRik Academy](https://docs.heyrik.com/academy/index.md): Follow the complete beginner learning path.
- [Build your first agent](https://docs.heyrik.com/academy/build-agent/index.md): Follow the complete course, lesson by lesson.

## Optional

- [Complete documentation](https://docs.heyrik.com/llms-full.txt): All 102 documentation pages and API operations in one file; use individual pages for focused questions.
- [Document index](https://docs.heyrik.com/docs-index.json): Titles, descriptions, original page URLs, and Markdown URLs for every exported document.