# Famulor

> Famulor documentation — build, deploy, and operate AI voice assistants.

- [API Reference (398 pages)](https://docs.famulor.io/_llms/en/api-reference.md): Documentation for API Reference.

## Documentation

### Getting started

- [Famulor overview](https://docs.famulor.io/index.md): What Famulor's AI voice assistants do and how the platform fits together
- [Quickstart](https://docs.famulor.io/quickstart.md): Create your first assistant and test it with a web call
- [Install the web app](https://docs.famulor.io/install-web-app.md): Install Famulor or your white-label workspace from the browser without an in-app install prompt.
- [Product tour](https://docs.famulor.io/product-tour.md): Explore Famulor: build assistants, connect your business, and manage daily operations
- [Account security](https://docs.famulor.io/account-security.md): Personal details, appearance, sign-in security, and how to delete your account
- [FAQ](https://docs.famulor.io/faq.md): Quick answers on getting started, telephony, pricing, compliance, and enterprise use
- [Voice AI glossary](https://docs.famulor.io/glossary.md): Terms used across Famulor and voice AI in general, A to Z
- [Support](https://docs.famulor.io/support.md): How to reach the Famulor team, what to include in a request, and enterprise support options
- [Trust Center](https://docs.famulor.io/support/trust-center.md): Transparency on Famulor's infrastructure, sub-processors, and technical safeguards
- [Enterprise](https://docs.famulor.io/enterprise.md): Dedicated support, higher concurrency, and a hands-on rollout for high-volume voice AI

### Assistants

- [System prompt vs. flow builder](https://docs.famulor.io/assistants/overview.md): Two ways to define assistant behavior — and when to use which
- [Assistant pictures](https://docs.famulor.io/assistants/pictures.md): Choose a mascot from the gallery or upload your own image.
- [Assistant compliance review](https://docs.famulor.io/assistants/compliance-review.md): Policy tags, restricted-use notices and manual review
- [Milian Copilot](https://docs.famulor.io/assistants/milian-copilot.md): In-app AI that builds and edits assistants in your workspace
- [Milian Missions](https://docs.famulor.io/assistants/routines.md): Build versioned, scheduled, and event-driven work for Milian.
- [Engine modes](https://docs.famulor.io/assistants/engine-modes.md): Pipeline, realtime, half-cascade, and Translate — choose how a conversation works
- [Translate](https://docs.famulor.io/assistants/translate.md): Run a live interpreted conversation between two people, on the web or by phone
- [Models & voices](https://docs.famulor.io/assistants/models-and-voices.md): Choose models, preview voices, clone your own, and turn on reliable fallbacks
- [Languages](https://docs.famulor.io/assistants/languages.md): Single-language setup, multilingual assistants, and automatic language switching
- [Assistant timezone](https://docs.famulor.io/assistants/timezone.md): How an assistant's IANA timezone shapes time-aware tools, variables, and business hours — and when a campaign overrides it
- [Knowledge bases](https://docs.famulor.io/assistants/knowledge-base.md): Help assistants answer from your documents and websites
- [Custom variables](https://docs.famulor.io/assistants/variables.md): Define per-assistant variables and inject live values — from the API, campaign leads, an inbound webhook, or system context — into prompts, greetings, and tools
- [Post-call analysis](https://docs.famulor.io/assistants/analysis.md): Automatically score sentiment, success, and extract structured data from every call
- [AI Quality Assurance](https://docs.famulor.io/assistants/ai-quality-assurance.md): Run cohort QA over call transcripts — packs, credits, dashboard.
- [Post-call webhooks](https://docs.famulor.io/assistants/webhooks.md): Receive the transcript, duration, input variables, and post-call analysis via webhook after every call.
- [Guardrails & conversation quality](https://docs.famulor.io/assistants/conversation-quality.md): Background audio, interruptions, filler phrases, idle and voicemail handling, ringing, consent, transcript privacy, and guardrails
- [Cross-channel customer memory](https://docs.famulor.io/assistants/memory.md): Carry consented customer context across voice, email, support, and connected messaging channels
- [Calendar & booking](https://docs.famulor.io/assistants/calendar-booking.md): Check availability, book appointments, and help customers reschedule or cancel with supported calendar integrations
- [Built-in calendar](https://docs.famulor.io/assistants/native-calendar.md): Famulor's built-in scheduling engine for booking appointments during calls — no external calendar account required
- [Built-in tools](https://docs.famulor.io/assistants/built-in-tools.md): Give assistants safe actions for calls, messages, scheduling, and data capture
- [Agent Tools](https://docs.famulor.io/assistants/agent-tools.md): A workspace-wide catalog of custom tools and pre-built connectors any assistant can call
- [Tools & webhooks](https://docs.famulor.io/api/tools-and-webhooks.md): Let assistants call tools during a conversation, and send call results to your systems through webhooks
- [Prompt writing](https://docs.famulor.io/assistants/prompt-writing.md): Structure, tighten, and iterate on the prompt your assistant follows on every call
- [Prompting for speech](https://docs.famulor.io/assistants/prompting-for-speech.md): Write numbers, dates, and identifiers so they come out sounding right when your assistant reads them aloud
- [Assistant simulations](https://docs.famulor.io/assistants/simulations.md): Test an assistant against an AI-played caller before it talks to a real one
- [Voice cloning consent](https://docs.famulor.io/assistants/voice-cloning-consent.md): What consent to get in place before you clone someone's voice for an assistant
- [iOS & Android call screening](https://docs.famulor.io/assistants/ios-call-screening.md): Turn on Pre-Call Automation so your assistant answers the screening question and waits for a real person

#### Example prompts

- [Example prompts](https://docs.famulor.io/assistants/example-prompts/overview.md): Ready-to-adapt system prompts for common assistant scenarios
- [Receptionist](https://docs.famulor.io/assistants/example-prompts/receptionist.md): Routes callers to the right team by topic, and takes a message when no one is available
- [Appointment booking](https://docs.famulor.io/assistants/example-prompts/appointment-booking.md): Understands why the caller wants an appointment, picks the right type, and books it
- [Intelligent voicemail](https://docs.famulor.io/assistants/example-prompts/intelligent-voicemail.md): Captures a caller's request and contact details for a callback, without trying to resolve it
- [First-level support](https://docs.famulor.io/assistants/example-prompts/first-level-support.md): Triages a support request, answers common questions, and routes what it can't resolve
- [Sales and collections](https://docs.famulor.io/assistants/example-prompts/sales-and-collections.md): Outbound scripts for a sales offer and a payment reminder, with objection handling built in

### Flow builder

- [Flow builder overview](https://docs.famulor.io/flow-builder/overview.md): Turn a call into a graph of agents, tools, and decisions
- [Flow node reference](https://docs.famulor.io/flow-builder/nodes.md): Every node type in the flow builder, with its fields and behavior
- [Flow builder best practices](https://docs.famulor.io/flow-builder/best-practices.md): Patterns that make flows reliable in production

### Telephony

- [Famulor Loop](https://docs.famulor.io/telephony/famulor-loop.md): Use the built-in business phone system on web, mobile, and registered desk phones.
- [Buying phone numbers](https://docs.famulor.io/telephony/phone-numbers.md): Search, buy, and manage numbers through the platform marketplace
- [SMS registration guide (US)](https://docs.famulor.io/telephony/sms-registration-guide.md): What to prepare so US carriers approve your business texting registration the first time
- [Caller ID verification](https://docs.famulor.io/telephony/caller-id.md): Verify a number you already own so it can be presented on outbound calls
- [Call forwarding to Famulor](https://docs.famulor.io/telephony/call-forwarding-setup.md): Forward calls from a phone you already have to a Famulor assistant
- [Carrier number import](https://docs.famulor.io/telephony/carrier-import.md): Import existing Twilio, Telnyx, or Vonage numbers with automatic SIP routing
- [BYO SIP trunk](https://docs.famulor.io/telephony/sip-trunks.md): Connect your own SIP provider and use your existing numbers
- [SIP provider guides](https://docs.famulor.io/telephony/providers/overview.md): Provider-specific inbound routing, authentication, signaling IPs, and test steps
- [Easybell SIP trunk](https://docs.famulor.io/telephony/providers/easybell.md): Route an Easybell DID to the platform with FQDN and source-IP authentication
- [Twilio Elastic SIP Trunking](https://docs.famulor.io/telephony/providers/twilio.md): Configure Twilio origination to the platform and allow Twilio signaling CIDRs
- [Telnyx SIP trunk](https://docs.famulor.io/telephony/providers/telnyx.md): Configure a Telnyx FQDN connection and its regional signaling sources
- [Plivo Zentrunk SIP Trunking](https://docs.famulor.io/telephony/providers/plivo.md): Configure an authenticated Plivo Origination URI or Plivo signaling sources
- [Wavix SIP trunk](https://docs.famulor.io/telephony/providers/wavix.md): Route a Wavix DID to the platform using the current gateway allowlist
- [Sinch Elastic SIP Trunking](https://docs.famulor.io/telephony/providers/sinch.md): Configure Sinch static endpoint routing and signaling CIDRs
- [DIDLogic SIP trunk](https://docs.famulor.io/telephony/providers/didlogic.md): Route DIDLogic numbers to the platform and allow current regional gateways
- [Vonage SIP Trunking](https://docs.famulor.io/telephony/providers/vonage.md): Configure Vonage SIP URI delivery with the official source subnets
- [Bandwidth SIP trunk](https://docs.famulor.io/telephony/providers/bandwidth.md): Route Bandwidth numbers to the platform using account-specific signaling IPs
- [Fonial SIP trunk](https://docs.famulor.io/telephony/providers/fonial.md): Connect a Fonial number with a SIP user for outbound and SIP-URI forwarding for inbound
- [Other and custom SIP providers](https://docs.famulor.io/telephony/providers/other-custom.md): Safe setup rules for PBXs and providers without a verified global signaling allowlist
- [PBX & contact center platforms](https://docs.famulor.io/telephony/providers/pbx-and-contact-center.md): Connect your own 3CX, Asterisk, Starface, Genesys Cloud, Five9, or Aircall deployment as a SIP trunk
- [SIP troubleshooting](https://docs.famulor.io/telephony/sip-troubleshooting.md): Diagnose outbound, inbound, and transfer failures on a BYO SIP trunk
- [Inbound & outbound calls](https://docs.famulor.io/telephony/inbound-outbound.md): How calls reach assistants — and how assistants place calls
- [Outbound call limits](https://docs.famulor.io/telephony/outbound-limits.md): Workspace-wide daily protection for calls placed through integrated numbers
- [WhatsApp Voice](https://docs.famulor.io/telephony/whatsapp-voice.md): How WhatsApp calling works on the platform — setup and product UX

### Channels

- [Messaging channels (Telegram, Slack, Messenger)](https://docs.famulor.io/channels/messaging.md): Connect Discord, Teams, Google Chat, and other messaging channels to one shared assistant
- [SMS conversations](https://docs.famulor.io/channels/sms.md): Connect a phone number to an assistant and manage SMS conversations in History
- [Email channel setup](https://docs.famulor.io/channels/email.md): Connect a sending domain, create addresses, and set assistant email defaults
- [WhatsApp (Text + Voice)](https://docs.famulor.io/channels/whatsapp.md): Connect WhatsApp Business Cloud API for chat and platform voice calls
- [Connect WhatsApp with Meta](https://docs.famulor.io/channels/whatsapp-embedded-signup.md): Connect a WhatsApp Business account inside Settings → Channels → WhatsApp

### Audience

- [Contacts](https://docs.famulor.io/audience/contacts.md): Create, edit, merge, and delete the people and businesses in your Audience
- [Importing contacts](https://docs.famulor.io/audience/importing-contacts.md): Bring contacts into Audience from a CSV file, with column mapping and validation
- [Audience Call QA](https://docs.famulor.io/audience/call-qa.md): Use per-contact call quality averages in Audience, segments, History, REST and MCP.

### Campaigns

- [Campaigns & leads](https://docs.famulor.io/campaigns/overview.md): Reach lead lists through multi-channel outbound campaigns — call, WhatsApp, or SMS
- [Dialer, retries & compliance](https://docs.famulor.io/campaigns/dialer-and-compliance.md): Parallel dialing, retry logic, calling windows, DNC lists, and voicemail handling
- [Outbound playbook](https://docs.famulor.io/campaigns/outbound-playbook.md): Who to call, when, what to say, and what to measure — a research-backed starting point for cold outreach

### Live operations

- [Live monitoring & supervisor](https://docs.famulor.io/monitoring/live-monitoring.md): Watch live transcripts, listen in, whisper to the AI, barge in, or take over
- [Conversation history](https://docs.famulor.io/monitoring/history.md): Every call, chat, and message in one unified conversation log
- [Natural-language dashboards](https://docs.famulor.io/analytics/natural-language-dashboards.md): Turn a plain-language analytics question into reviewable dashboard insights
- [Custom dashboards](https://docs.famulor.io/analytics/custom-dashboards.md): Build your own analytics dashboards from live workspace data
- [Dashboard widgets](https://docs.famulor.io/analytics/dashboard-widgets.md): Reference for widget data sources, visualizations, aggregations, and filters
- [Email history](https://docs.famulor.io/email/history.md): Review assistant email conversations alongside calls.
- [Web widget](https://docs.famulor.io/web-widget.md): Embed your assistant as a voice and chat widget on any website

### Workspace settings

- [Workspaces](https://docs.famulor.io/settings/workspaces.md): Switch workspaces, create additional ones, and manage each workspace's profile and team
- [AI regions & models](https://docs.famulor.io/settings/ai-regions.md): Choose your workspace AI region, compare EU and US model endpoints, and understand SIP routing and infrastructure locations
- [Consent & compliance](https://docs.famulor.io/settings/consent-compliance.md): Choose universal or per-channel opt-outs and manage cross-channel suppression records.
- [Dark Windows](https://docs.famulor.io/settings/dark-windows.md): Pause proactive outbound activity per channel during quiet hours.
- [Data retention](https://docs.famulor.io/settings/data-retention.md): Control how long each workspace data channel is kept.
- [Audit log](https://docs.famulor.io/settings/audit-log.md): See who changed what across your workspace, and when
- [Migrate from Retell AI, Vapi, Synthflow, or ElevenAgents](https://docs.famulor.io/settings/provider-migrations.md): Preview which assistants and settings are copied, then import them into your Famulor workspace.
- [Migrate from Famulor 1.0](https://docs.famulor.io/settings/famulor-migration.md): Preview and import supported assistants, tools, knowledge, campaigns, automations, and BYO telephony

### Billing

- [How usage is billed](https://docs.famulor.io/billing/minutes.md): Plan credits, top-up credits, and how calls consume your balance
- [Invoices and payment recovery](https://docs.famulor.io/billing/manage-billing.md): Pay an open invoice, update payment details, and understand what happens after a failed plan payment
- [Plans and add-ons](https://docs.famulor.io/billing/plans-and-addons.md): Understand your plan, included capacity and available add-ons in Settings or with Milian.
- [Refer and Earn](https://docs.famulor.io/billing/referrals.md): Share your referral link — you and your friend earn wallet credits when they become a paying customer.

## Automation

### Automation

- [Automations](https://docs.famulor.io/automations/overview.md): Native workspace workflows — triggers, actions, run history, and assistant webhook binding.
- [Automation node reference](https://docs.famulor.io/automations/nodes.md): Every trigger and step in the Automation builder, with its fields and behavior
- [Milian AI — Automations](https://docs.famulor.io/api-reference/automation-ai.md): Milian AI: more actions for your automations
- [Conversation trigger test data](https://docs.famulor.io/api-reference/automation-trigger-test-data.md): Preview configured fields and capture a real conversation without running the workflow from the test panel.
- [App Catalog](https://docs.famulor.io/automations/app-catalog.md): Every platform you can pick a trigger or an action from in the Automation builder
- [Connect Shopify](https://docs.famulor.io/automations/shopify.md): Connect your Shopify store to Automations with your own Dev Dashboard app — no App Store review, no sign-in window
- [CRM sync](https://docs.famulor.io/automations/crm-sync.md): Keep Audience contacts aligned with your CRM and write call outcomes back through automations.

### Integrations

- [Zapier](https://docs.famulor.io/automations/zapier.md): Connect Famulor to Zapier and build workflows for contacts, calls, campaigns, and bookings.
- [Make.com](https://docs.famulor.io/automations/make-com.md): Connect Make.com scenarios to the Famulor workspace API with the HTTP module.
- [n8n](https://docs.famulor.io/automations/n8n.md): Connect Famulor to n8n with native actions, polling events and signed booking webhooks.
- [Activepieces](https://docs.famulor.io/automations/activepieces.md): Find the Famulor Activepieces integration and use the workspace API in your flows.

## White Label

### White Label Program

- [White Label Program](https://docs.famulor.io/admin/tenants-and-whitelabel.md): What White Label access is, how customer workspaces are isolated, and how to support and manage your customers

### White Label Platform

- [White Label Platform](https://docs.famulor.io/admin/dashboard.md): Read the KPI tiles, usage charts, plan margins, and current contribution snapshot on your white-label admin landing page

### White Label Setup

- [White Label Setup](https://docs.famulor.io/admin/whitelabel-setup.md): Configure branding, domain, currency, legal pages, email, retention, and bot protection for your white-label platform
- [Marketing integrations](https://docs.famulor.io/settings/marketing.md): Configure GA4, Meta, Google Ads and Microsoft UET on a white-label domain.

### Prompt Templates

- [Prompt Templates](https://docs.famulor.io/admin/prompt-templates.md): Build reusable starting points for your customers' assistants — a system prompt, first message, and optional flow

### Billing & Payment Management

- [Credit balances & transfers](https://docs.famulor.io/admin/balances-and-transfers.md): Track prepaid credits and fund customer workspaces
- [Payments with Stripe](https://docs.famulor.io/admin/stripe.md): Manage workspace billing and charge white-label customers

### Plans & Pricing Setup

- [Plans & Pricing Setup](https://docs.famulor.io/admin/plans-and-limits.md): Create clear white-label customer plans with pricing, included usage, limits, and add-ons

### User Limits Management

- [User Limits Management](https://docs.famulor.io/admin/user-limits.md): Set default limits and features for prepaid customers, and override plan limits or navigation for one specific customer

### Data Migration

- [Data Migration](https://docs.famulor.io/admin/data-migration.md): Selectively move assistants, numbers, tools and more between your customer workspaces, with a reviewable history and rollback

### White Label API

- [White Label API](https://docs.famulor.io/admin/whitelabel-api.md): Manage your reseller platform's customers programmatically — list, register, mint tokens, log in, log out, transfer credits, and bill custom payments

## MCP

### MCP

- [Connect an AI client](https://docs.famulor.io/mcp/overview.md): Connect Claude, ChatGPT, or another MCP client to your Famulor workspace
- [Tools and scopes](https://docs.famulor.io/mcp/tools-and-scopes.md): The full MCP tool catalog, how to scope it, and the read-only public profile
- [Use cases](https://docs.famulor.io/mcp/use-cases.md): Prompt examples for working with Famulor through an MCP client

## CLI

### CLI

- [Famulor CLI](https://docs.famulor.io/cli/overview.md): Your whole Famulor workspace in the terminal: every API operation as a command
- [Log in and workspaces](https://docs.famulor.io/cli/authentication.md): API keys, the system keychain, CI credentials, one profile per workspace and white-label domains
- [Commands and output](https://docs.famulor.io/cli/commands.md): Find commands, build request bodies, upload files and choose between JSON, tables and JSON Lines
- [Scripts, CI and coding agents](https://docs.famulor.io/cli/scripting.md): Automate Famulor safely: clean output, exit codes, confirmations, dry runs and a command schema for agents
- [Reference](https://docs.famulor.io/cli/reference.md): Global options, environment variables, files, shell completion and troubleshooting for the Famulor CLI

## API 1.0 (Legacy)

### API Reference

- [Introduction](https://docs.famulor.io/api-v1/introduction.md): Programmatically manage Famulor AI voice agents, leads, calls, campaigns and knowledge bases via the REST API. Complete reference for developers.
- [Authentication](https://docs.famulor.io/api-v1/authentication.md): Learn how to authenticate your Famulor API requests using Bearer tokens. Generate API keys and securely access voice agent, lead, and campaign endpoints.
- [Get User Information](https://docs.famulor.io/api-v1/user/me.md): Retrieve the profile, settings and account details of the currently authenticated Famulor user via API. Useful for verifying tokens and account state.

### AI Assistants

- [Create Assistants](https://docs.famulor.io/api-v1/assistants/create.md): Create a new AI assistant with specified configuration
- [Delete Assistant](https://docs.famulor.io/api-v1/assistants/delete.md): Permanently delete a specific Famulor AI voice assistant via API, including its prompt, configuration and call history. This action cannot be reversed.
- [Enable assistant inbound webhook](https://docs.famulor.io/api-v1/assistants/enable-inbound-webhook.md): Activate inbound webhook notifications for an assistant
- [Disable assistant inbound webhook](https://docs.famulor.io/api-v1/assistants/disable-inbound-webhook.md): Turn off inbound webhook notifications for an assistant
- [Enable Conversation Ended Webhook](https://docs.famulor.io/api-v1/assistants/enable-conversation-ended-webhook.md): Enable conversation-ended webhook notifications for chat conversations
- [Disable conversation ended webhook](https://docs.famulor.io/api-v1/assistants/disable-conversation-ended-webhook.md): Disable conversation ended webhook notifications for an assistant
- [Disable assistant webhook](https://docs.famulor.io/api-v1/assistants/disable-webhook.md): Turn off webhook notifications for a specific Famulor AI assistant via API. Stops automated event delivery for call ended, lead created, and other triggers.
- [Retrieve Available Languages](https://docs.famulor.io/api-v1/assistants/languages.md): Retrieve all available languages for assistant configuration
- [List Assistants](https://docs.famulor.io/api-v1/assistants/list.md): List all assistants for the authenticated user with pagination
- [Assistant pictures](https://docs.famulor.io/api-v1/assistants/avatar-gallery.md): Choose a mascot from the gallery or upload your own image.
- [Retrieve Available Models](https://docs.famulor.io/api-v1/assistants/models.md): Retrieve available AI models for assistant configuration
- [Get outbound assistants](https://docs.famulor.io/api-v1/assistants/outbound.md): Retrieve all outbound assistants for the authenticated user
- [Retrieve Available Phone Numbers](https://docs.famulor.io/api-v1/assistants/phone-numbers.md): Retrieve all available phone numbers for assistant assignment
- [List synthesizer providers](https://docs.famulor.io/api-v1/assistants/synthesizer-providers.md): Retrieve available TTS (text-to-speech) synthesizer providers
- [List transcriber providers](https://docs.famulor.io/api-v1/assistants/transcriber-providers.md): Retrieve available STT (speech-to-text) transcriber providers
- [Update Assistant](https://docs.famulor.io/api-v1/assistants/update.md): Update the configuration of an existing AI assistant
- [Retrieve Available Voices](https://docs.famulor.io/api-v1/assistants/voices.md): Retrieve all available voices for assistant configuration

### Folders

- [List Folders](https://docs.famulor.io/api-v1/folders/list.md): List the folders in your account
- [Create Folder](https://docs.famulor.io/api-v1/folders/create.md): Create a folder to organize your assistants
- [Update Folder](https://docs.famulor.io/api-v1/folders/update.md): Rename a folder or change its color
- [Delete Folder](https://docs.famulor.io/api-v1/folders/delete.md): Delete a folder

### Labels

- [List Labels](https://docs.famulor.io/api-v1/labels/list.md): List the labels in your account
- [Create Label](https://docs.famulor.io/api-v1/labels/create.md): Create a label to tag your assistants
- [Update Label](https://docs.famulor.io/api-v1/labels/update.md): Rename a label or change its color
- [Delete Label](https://docs.famulor.io/api-v1/labels/delete.md): Delete a label

### Leads

- [List Leads](https://docs.famulor.io/api-v1/leads/list.md): Retrieve a paginated list of all leads for the authenticated Famulor account via API. Filter, sort and access contact details for voice agent campaigns.
- [Create lead](https://docs.famulor.io/api-v1/leads/create.md): Add a new lead to your Famulor outbound calling campaign via API. Submit contact information, custom variables and trigger AI voice agent calls.
- [Update Lead](https://docs.famulor.io/api-v1/leads/update.md): Update an existing Famulor lead via API. Modify contact information, custom variables, status and campaign assignment for AI voice outreach.
- [Delete lead](https://docs.famulor.io/api-v1/leads/delete.md): Permanently remove a lead from your Famulor account via API. Deletes all associated call data, transcripts and notes for that contact record.

### Campaigns

- [List Campaigns](https://docs.famulor.io/api-v1/campaigns/list.md): List all campaigns (call, WhatsApp, SMS) in your Famulor account via API. View channel, schedule windows, WhatsApp/SMS config, and optional call→text fallback settings.
- [Get campaign](https://docs.famulor.io/api-v1/campaigns/get.md): Get a single Famulor campaign by ID via API. Returns channel, schedule windows, WhatsApp/SMS config, and optional call→text fallback fields.
- [Create campaign](https://docs.famulor.io/api-v1/campaigns/create.md): Create a draft call, WhatsApp, or SMS campaign in Famulor via API. Add leads, then start with Update campaign status.
- [Update campaign status](https://docs.famulor.io/api-v1/campaigns/update-status.md): Start or stop a call, WhatsApp, or SMS campaign via API. Starting validates channel config, schedule, and balance.
- [Delete campaign](https://docs.famulor.io/api-v1/campaigns/delete.md): Delete an outbound calling campaign via API. Running campaigns are stopped automatically before removal; leads and phone number assignments are released.

### Automations

- [List automations](https://docs.famulor.io/api-v1/automations/list.md): List every Famulor automation in your account, including status and assistant bindings.
- [Get automation](https://docs.famulor.io/api-v1/automations/get.md): Get a single Famulor automation, including its full definition (trigger and chained steps).
- [Create automation](https://docs.famulor.io/api-v1/automations/create.md): Create a Famulor automation from a definition, activate it, and prove it with a real test run.
- [Update automation](https://docs.famulor.io/api-v1/automations/update.md): Rename a Famulor automation, turn it on or off, or repair it with a corrected definition.
- [Restore previous version](https://docs.famulor.io/api-v1/automations/restore.md): Roll a Famulor automation back to its previous published version.
- [Delete automation](https://docs.famulor.io/api-v1/automations/delete.md): Permanently delete a Famulor automation from your account.
- [List automation runs](https://docs.famulor.io/api-v1/automations/list-runs.md): List a Famulor automation’s recent executions, or one execution’s step-by-step detail.
- [Retry automation run](https://docs.famulor.io/api-v1/automations/retry-run.md): Retry a failed Famulor automation run from its failed step without re-executing succeeded steps.
- [List automation templates](https://docs.famulor.io/api-v1/automations/list-templates.md): List ready-made Famulor automation templates and the parameters each one needs.
- [Apply automation template](https://docs.famulor.io/api-v1/automations/apply-template.md): Create a Famulor automation from a ready-made template and prove it with a real test run.

### Mid Call Actions

- [List Mid-call Actions](https://docs.famulor.io/api-v1/mid-call-tools/get-tools.md): Retrieve all Mid-call Actions available in your Famulor account via API. Useful for inventory, debugging and attaching actions to AI voice assistants.
- [Get Mid-call Action](https://docs.famulor.io/api-v1/mid-call-tools/get-tool.md): Retrieve detailed information about a specific Mid-call Action
- [Create Mid-call Action](https://docs.famulor.io/api-v1/mid-call-tools/create-tool.md): Create a new Mid-call Action for AI assistant integration
- [Update Mid-call Action](https://docs.famulor.io/api-v1/mid-call-tools/update-tool.md): Modify an existing Mid-call Action in Famulor via API. Update name, endpoint, parameters or description so AI voice agents call the right action.
- [Delete Mid-call Action](https://docs.famulor.io/api-v1/mid-call-tools/delete-tool.md): Permanently remove a Mid-call Action from your Famulor account via API. Detaches the action from any AI voice assistant currently configured to use it.

### AI Chatbot

- [List Conversations](https://docs.famulor.io/api-v1/conversations/list.md): List all conversations of the authenticated user with filtering and cursor pagination
- [Disable AI](https://docs.famulor.io/api-v1/conversations/disable-ai.md): Disable AI replies for a specific conversation and hand over to a human
- [Enable AI](https://docs.famulor.io/api-v1/conversations/enable-ai.md): Re-enable AI replies for a conversation after a human takeover
- [Create conversation](https://docs.famulor.io/api-v1/ai-chatbot/create-conversation.md): Start a new conversation session with a Famulor AI chatbot via API. Initialise context, user metadata and channel for WhatsApp, web chat or voice chat.
- [Get conversation](https://docs.famulor.io/api-v1/ai-chatbot/get-conversation.md): Retrieve full message history for an existing conversation
- [Send message](https://docs.famulor.io/api-v1/ai-chatbot/send-conversation.md): Send a user message to an existing conversation and receive the assistant's response

### AI Replies

- [Generate AI Reply](https://docs.famulor.io/api-v1/ai-replies/generate-reply.md): Generates an AI reply using an assistant based on a customer identifier

### Knowledgebases

- [List Knowledge Bases](https://docs.famulor.io/api-v1/knowledgebases/list.md): Retrieves all knowledge bases of the authenticated user
- [Get Knowledge Base](https://docs.famulor.io/api-v1/knowledgebases/get.md): Retrieves details of a specific knowledge base by ID
- [Create Knowledge Base](https://docs.famulor.io/api-v1/knowledgebases/create.md): Create a new knowledge base in Famulor via API to power your AI voice assistants with company information, FAQs, product details and reference documents.
- [Update Knowledge Base](https://docs.famulor.io/api-v1/knowledgebases/update.md): Update an existing Famulor knowledge base via API. Rename, change settings or modify metadata for the source data feeding your AI voice assistants.
- [Delete Knowledge Base](https://docs.famulor.io/api-v1/knowledgebases/delete.md): Permanently delete a Famulor knowledge base and all its documents via API. AI voice assistants will lose access to the indexed content immediately.
- [List Documents](https://docs.famulor.io/api-v1/knowledgebases/list-documents.md): List all documents stored in a specific Famulor knowledge base via API. Inspect filenames, sizes and indexing status used by AI voice assistants.
- [Get Document](https://docs.famulor.io/api-v1/knowledgebases/get-document.md): Retrieve details of a specific document inside a Famulor knowledge base by ID via API. Get content, metadata and processing status for AI voice agents.
- [Create Document](https://docs.famulor.io/api-v1/knowledgebases/create-document.md): Upload a new document to a Famulor knowledge base via API. Add PDFs, text, FAQs or product data that AI voice assistants can reference during calls.
- [Update Document](https://docs.famulor.io/api-v1/knowledgebases/update-document.md): Update the name or description of a document in a Famulor knowledge base via API. Keep your AI voice agent's source materials organized and labelled.
- [Delete Document](https://docs.famulor.io/api-v1/knowledgebases/delete-document.md): Delete a specific document from a Famulor knowledge base via API. Permanently removes its content from the RAG index used by your AI voice assistant.

### SMS

- [Send SMS](https://docs.famulor.io/api-v1/sms/send.md): Send an SMS message using your Famulor phone number via API. Trigger transactional or follow-up texts after AI voice calls, lead capture or campaigns.

### WhatsApp

- [Get WhatsApp Senders](https://docs.famulor.io/api-v1/whatsapp/get-senders.md): List WhatsApp Business senders configured in your Famulor account
- [Get WhatsApp Templates](https://docs.famulor.io/api-v1/whatsapp/get-templates.md): List WhatsApp message templates for a specific Famulor sender
- [Send WhatsApp Template Message](https://docs.famulor.io/api-v1/whatsapp/send-template.md): Send a WhatsApp message using an approved template via Famulor
- [Send WhatsApp Freeform Message](https://docs.famulor.io/api-v1/whatsapp/send-freeform.md): Send a free-text WhatsApp message within an active 24-hour session via Famulor
- [Get WhatsApp Session Status](https://docs.famulor.io/api-v1/whatsapp/session-status.md): Check the 24-hour WhatsApp messaging window status for a Famulor conversation

### Phone Numbers

- [List Phone Numbers](https://docs.famulor.io/api-v1/phone-numbers/list.md): Retrieves all phone numbers of the authenticated user
- [Update Phone Number](https://docs.famulor.io/api-v1/phone-numbers/update.md): Update a phone number's nickname
- [Search Available Phone Numbers](https://docs.famulor.io/api-v1/phone-numbers/search.md): Searches for available phone numbers that can be purchased
- [Purchase Phone Number](https://docs.famulor.io/api-v1/phone-numbers/purchase.md): Purchase a dedicated phone number in Famulor via API. Acquire local, mobile or toll-free numbers for inbound or outbound AI voice agent calls.
- [Release Phone Number](https://docs.famulor.io/api-v1/phone-numbers/release.md): Releases a phone number and cancels its subscription

### SIP Trunks

- [List SIP Trunks](https://docs.famulor.io/api-v1/sip-trunks/list.md): Get all SIP trunks owned by the authenticated user
- [Get SIP Trunk](https://docs.famulor.io/api-v1/sip-trunks/get.md): Retrieve full configuration of a single SIP trunk in Famulor by ID via API. Inspect credentials, routing and assigned numbers for your AI voice telephony.
- [Create SIP Trunk](https://docs.famulor.io/api-v1/sip-trunks/create.md): Create a new SIP trunk with credentials, address, and proxy settings
- [Update SIP Trunk](https://docs.famulor.io/api-v1/sip-trunks/update.md): Update an existing SIP trunk configuration in Famulor via API. Change credentials, routing rules and assigned phone numbers for your AI voice telephony.
- [Delete SIP Trunk](https://docs.famulor.io/api-v1/sip-trunks/delete.md): Delete a SIP trunk and clean up voice infrastructure

### Calls

- [List Calls](https://docs.famulor.io/api-v1/calls/list.md): List all calls for the authenticated user with filtering options
- [Get Call](https://docs.famulor.io/api-v1/user/calls/get.md): Retrieve full details of a specific Famulor call by ID via API, including transcript, recording URL, duration, status and metadata from the AI voice assistant.
- [Make a Call](https://docs.famulor.io/api-v1/calls/make.md): Initiate an outbound phone call with a specific Famulor AI assistant via API. Pass lead data and trigger automated voice conversations programmatically.
- [Delete Call](https://docs.famulor.io/api-v1/calls/delete.md): Delete a specific call record from the Famulor system via API. Permanently removes transcripts, recordings and metadata for that voice agent call.

### Webhooks

- [Post-Call Webhook](https://docs.famulor.io/api-v1/webhooks/post-call.md): Webhook sent after a call ends containing extracted variables and call data
- [Conversation Ended Webhook](https://docs.famulor.io/api-v1/webhooks/conversation-ended.md): Webhook sent after a chat conversation ends containing transcript, extracted variables, and customer data
- [Read Receipts Webhook](https://docs.famulor.io/api-v1/webhooks/read-receipts.md): Signed webhook sent on every delivery-status change (sent, delivered, read, failed) of a WhatsApp message you send

## What's New

### What's New

- [Changelog](https://docs.famulor.io/changelog.md): New features and improvements, newest first
- [Changelog — Famulor 1.0](https://docs.famulor.io/changelog-v1.md): Release history of the previous platform generation, kept for reference

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [English / API Reference (398 pages)](https://docs.famulor.io/_llms/en/api-reference.md): Documentation for English / API Reference.
- [English / API Reference / Knowledge Bases (29 pages)](https://docs.famulor.io/_llms/en/api-reference/knowledge-bases.md): Documentation for English / API Reference / Knowledge Bases.
- [English / API Reference / Famulor Loop (37 pages)](https://docs.famulor.io/_llms/en/api-reference/famulor-loop.md): Documentation for English / API Reference / Famulor Loop.
- [English / API Reference / Messaging (33 pages)](https://docs.famulor.io/_llms/en/api-reference/messaging.md): Documentation for English / API Reference / Messaging.
- [French (622 pages)](https://docs.famulor.io/_llms/fr.md): Documentation for French.
- [French / Référence API (398 pages)](https://docs.famulor.io/_llms/fr/reference-api.md): Documentation for French / Référence API.
- [French / Référence API / Bases de connaissances (29 pages)](https://docs.famulor.io/_llms/fr/reference-api/bases-de-connaissances.md): Documentation for French / Référence API / Bases de connaissances.
- [French / Référence API / Famulor Loop (37 pages)](https://docs.famulor.io/_llms/fr/reference-api/famulor-loop.md): Documentation for French / Référence API / Famulor Loop.
- [French / Référence API / Messagerie (33 pages)](https://docs.famulor.io/_llms/fr/reference-api/messagerie.md): Documentation for French / Référence API / Messagerie.
- [Spanish (622 pages)](https://docs.famulor.io/_llms/es.md): Documentation for Spanish.
- [Spanish / Referencia de la API (398 pages)](https://docs.famulor.io/_llms/es/referencia-de-la-api.md): Documentation for Spanish / Referencia de la API.
- [Spanish / Referencia de la API / Bases de conocimiento (29 pages)](https://docs.famulor.io/_llms/es/referencia-de-la-api/bases-de-conocimiento.md): Documentation for Spanish / Referencia de la API / Bases de conocimiento.
- [Spanish / Referencia de la API / Famulor Loop (37 pages)](https://docs.famulor.io/_llms/es/referencia-de-la-api/famulor-loop.md): Documentation for Spanish / Referencia de la API / Famulor Loop.
- [Spanish / Referencia de la API / Mensajería (33 pages)](https://docs.famulor.io/_llms/es/referencia-de-la-api/mensajeria.md): Documentation for Spanish / Referencia de la API / Mensajería.
- [German (622 pages)](https://docs.famulor.io/_llms/de.md): Documentation for German.
- [German / API-Referenz (398 pages)](https://docs.famulor.io/_llms/de/api-referenz.md): Documentation for German / API-Referenz.
- [German / API-Referenz / Wissensdatenbanken (29 pages)](https://docs.famulor.io/_llms/de/api-referenz/wissensdatenbanken.md): Documentation for German / API-Referenz / Wissensdatenbanken.
- [German / API-Referenz / Famulor Loop (37 pages)](https://docs.famulor.io/_llms/de/api-referenz/famulor-loop.md): Documentation for German / API-Referenz / Famulor Loop.
- [German / API-Referenz / Messaging (33 pages)](https://docs.famulor.io/_llms/de/api-referenz/messaging.md): Documentation for German / API-Referenz / Messaging.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.