add_campaign_contacts
ChatGPTAdds up to 500 contacts (phone + optional fields) to a campaign. A running — or already completed — campaign DIALS THEM AUTOMATICALLY and spends credits, so confirm with the user first and pass confirm: true. Maps to POST /api/v1/campaigns/{id}/contacts. Needs the calls:write permission.
add_knowledge_url
ChatGPTHeyRik fetches the page, extracts its text and adds it to the agent's knowledge base (applies to the next call). Maps to POST /api/v1/agents/{id}/knowledge with { url }. Needs the write permission.
assign_phone_number
ChatGPTChoose which agent answers (and calls from) one of the account's phone numbers.
call_leads
ChatGPTCOSTS CREDITS AND DIALS REAL PHONES: an agent calls the given leads now. Repeat the leads, agent and cost to the user, get an explicit yes, then call with confirm: true. Needs the calls:write permission.
cancel_campaign
ChatGPTStop 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.)
create_agent
ChatGPTCreate 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_campaign
ChatGPTCreate 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_lead
ChatGPTAdd a lead (contact) to the HeyRik CRM.
create_widget
ChatGPTCreate a chat/voice widget that puts one of the account's agents on a website.
delete_agent
ChatGPTPermanently delete an agent. Repeat the agent's name to the user, get an explicit yes, then call with confirm: true.
delete_campaign
ChatGPTPermanently delete a campaign and its contact list. Confirm first; pass confirm: true.
delete_knowledge
ChatGPTRemove one document or web page from an agent's knowledge. Confirm with the user, then call with confirm: true.
delete_lead
ChatGPTPermanently delete a lead from the CRM. Confirm first; pass confirm: true.
delete_widget
ChatGPTPermanently delete a widget (websites embedding it stop working). Confirm first; pass confirm: true.
get_account
ChatGPTThe connected HeyRik account (id, name, email) and its credit balance (1 credit ≈ 1 call minute). Check this before placing calls. Maps to GET /api/v1/me + /api/v1/balance.
get_agent
ChatGPTFull configuration of one agent: greeting, prompt / Conversation Flow sections, voice settings, languages, call behaviour, extracted variables. Maps to GET /api/v1/agents/{id}.
get_analytics
ChatGPTAccount-wide call analytics (volume, outcomes, durations, trends), optionally for one agent and a date range.
get_call
ChatGPTOne 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_functions
ChatGPTThe functions / custom APIs the agent ran during one call, with inputs and results.
get_call_stats
ChatGPTAggregate call counts and durations for the account or one agent. Maps to GET /api/v1/calls/stats.
get_campaign
ChatGPTOne campaign: settings, status, contact counts by status and by outcome category. Maps to GET /api/v1/campaigns/{id}.
get_campaign_analytics
ChatGPTOutcome breakdown, connect rate and durations for one campaign.
get_chat_transcript
ChatGPTThe full transcript of one chat session.
get_knowledge_content
ChatGPTThe extracted text of one knowledge source (long documents are truncated). Maps to GET /api/v1/agents/{id}/knowledge/{kid}/content.
get_lead
ChatGPTOne CRM lead with its fields and pipeline stage.
get_lead_calls
ChatGPTEvery call made to or from one lead.
get_leads_summary
ChatGPTLead counts by pipeline stage and folder.
get_phone_number
ChatGPTOne phone number with its direction and the agent that answers it.
get_usage
ChatGPTCredit and call-minute usage for the account over a date range.
get_voice_options
ChatGPTLanguages, speaking speeds and other voice settings an agent can use.
list_agents
ChatGPTList the account's AI phone agents (assistants) with id, name, language and greeting. Paginated (limit ≤ 100). Maps to GET /api/v1/agents.
list_calls
ChatGPTRecent 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_campaign_contacts
ChatGPTContacts in a campaign with their call status and result. Filter by status; paginated (limit ≤ 100). Maps to GET /api/v1/campaigns/{id}/contacts.
list_campaigns
ChatGPTBulk-call campaigns with status and per-status contact counts. Paginated (limit ≤ 100). Maps to GET /api/v1/campaigns.
list_chat_sessions
ChatGPTText-chat conversations people had with the account's chat agents. Paginated.
list_crm_folders
ChatGPTFolders the account's leads are organised in.
list_crm_stages
ChatGPTThe pipeline stages a lead can be in (use with set_lead_stage).
list_custom_apis
ChatGPTHTTP tools (custom APIs) the account's agents can call during conversations.
list_knowledge
ChatGPTDocuments and web pages an agent answers from (id, name, kind, size). Maps to GET /api/v1/agents/{id}/knowledge.
list_leads
ChatGPTLeads in the HeyRik CRM, filterable by stage, folder or a search term. Paginated.
list_phone_numbers
ChatGPTThe 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_plans
ChatGPTHeyRik plans and the credits each includes.
list_voices
ChatGPTVoices 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_widgets
ChatGPTChat/voice widgets that put one of the account's agents on a website.
pause_campaign
ChatGPTStop 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.
place_call
ChatGPTCOSTS 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.
set_agent_instructions
ChatGPTReplace 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_lead_stage
ChatGPTMove a lead to another pipeline stage (stage names from list_crm_stages).
start_campaign
ChatGPTCOSTS 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.
update_agent
ChatGPTChange 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_campaign
ChatGPTRename 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_lead
ChatGPTChange a lead's name, phone, email, company, stage or custom fields. Only the fields you pass change.