HeyRik

Stop a campaign for good: contacts not yet called are never called. Confirm with the user, then call with confirm: true. (pause_campaign can be resumed; this cannot.)

cancel_campaign

The full transcript of one chat session.

get_chat_transcript

Create a new AI phone agent. Give it a name and either prompt_sections (preferred) or a single system_prompt; optionally a greeting, language and voice (ids from list_voices).

create_agent

Create a bulk-call campaign as a draft (nothing is dialled). Then add contacts with add_campaign_contacts and start or schedule it with start_campaign (which needs the user's confirmation).

create_campaign

Add a lead (contact) to the HeyRik CRM.

create_lead

Create a chat/voice widget that puts one of the account's agents on a website.

create_widget

Permanently delete an agent. Repeat the agent's name to the user, get an explicit yes, then call with confirm: true.

delete_agent

Permanently delete a campaign and its contact list. Confirm first; pass confirm: true.

delete_campaign

Permanently delete a lead from the CRM. Confirm first; pass confirm: true.

delete_lead

Permanently delete a widget (websites embedding it stop working). Confirm first; pass confirm: true.

delete_widget

Full configuration of one agent: greeting, prompt / Conversation Flow sections, voice settings, languages, call behaviour, extracted variables. Maps to GET /api/v1/agents/{id}.

get_agent

One call in detail: status, timing, outcome, AI summary, extracted data, transcript (last N turns) and a temporary recording link. Maps to GET /api/v1/calls/{id}.

get_call

One campaign: settings, status, contact counts by status and by outcome category. Maps to GET /api/v1/campaigns/{id}.

get_campaign

One CRM lead with its fields and pipeline stage.

get_lead

One phone number with its direction and the agent that answers it.

get_phone_number

Lead counts by pipeline stage and folder.

get_leads_summary

Leads in the HeyRik CRM, filterable by stage, folder or a search term. Paginated.

list_leads

List the account's AI phone agents (assistants) with id, name, language and greeting. Paginated (limit ≤ 100). Maps to GET /api/v1/agents.

list_agents

Recent calls, newest first, with state, direction, agent, number, outcome and duration (no transcript; use get_call). Paginated by page/limit (≤ 100). Maps to GET /api/v1/calls.

list_calls

Contacts in a campaign with their call status and result. Filter by status; paginated (limit ≤ 100). Maps to GET /api/v1/campaigns/{id}/contacts.

list_campaign_contacts

Bulk-call campaigns with status and per-status contact counts. Paginated (limit ≤ 100). Maps to GET /api/v1/campaigns.

list_campaigns

Text-chat conversations people had with the account's chat agents. Paginated.

list_chat_sessions

HTTP tools (custom APIs) the account's agents can call during conversations.

list_custom_apis

Documents and web pages an agent answers from (id, name, kind, size). Maps to GET /api/v1/agents/{id}/knowledge.

list_knowledge

The account's phone numbers (SIP trunks) with direction and the agent that answers each. place_call needs one of these ids (outbound or both). Maps to GET /api/v1/phone-numbers.

list_phone_numbers

Voices an agent can speak with (library voices, or this account's cloned voices with type=cloned). Filter by language/gender/search. Use an id with update_agent.voice_id. Maps to GET /api/v1/voices.

list_voices

Chat/voice widgets that put one of the account's agents on a website.

list_widgets

Move a lead to another pipeline stage (stage names from list_crm_stages).

set_lead_stage

Stop a running campaign from dialling further contacts (calls in progress finish). Safe: it stops spending. Maps to POST /api/v1/campaigns/{id}/pause. Needs the write permission.

pause_campaign

COSTS CREDITS AND DIALS A REAL PHONE: an agent calls the given number now from one of the account's phone numbers. Only when the user explicitly asks; confirm number, agent and cost with them first, then pass confirm: true. Maps to POST /api/v1/calls/dispatch. Needs the calls:write permission.

place_call

HeyRik plans and the credits each includes.

list_plans

The extracted text of one knowledge source (long documents are truncated). Maps to GET /api/v1/agents/{id}/knowledge/{kid}/content.

get_knowledge_content

Remove one document or web page from an agent's knowledge. Confirm with the user, then call with confirm: true.

delete_knowledge

Replace an agent's instructions with new prompt sections (the builder's Conversational Flow). For name, greeting, language, a one-block prompt or the voice, use update_agent. Applies from the next call.

set_agent_instructions

Choose which agent answers (and calls from) one of the account's phone numbers.

assign_phone_number

COSTS CREDITS AND DIALS REAL PHONES: starts (or schedules, with schedule_at) a campaign, which calls every pending contact. Confirm the campaign, contact count and cost with the user first, then pass confirm: true. Maps to POST /api/v1/campaigns/{id}/start. Needs the calls:write permission.

start_campaign

The functions / custom APIs the agent ran during one call, with inputs and results.

get_call_functions

Change an agent's name, greeting, language, free-text prompt (system_prompt) or voice. Only the fields you pass change; applies from the next call. Maps to PATCH /api/v1/agents/{id}. Needs the write permission.

update_agent

Rename a campaign or change its retries and calling window. Only the fields you pass change. (Scheduling a start is start_campaign with schedule_at.)

update_campaign

Change a lead's name, phone, email, company, stage or custom fields. Only the fields you pass change.

update_lead