# Talkif Docs

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.talkif.ai/_mcp/server

## Docs

- [Introduction](https://docs.talkif.ai/getting-started/introduction.md): What Talkif is, the four things every call depends on, and how the dashboard and the API fit together.
- [Quickstart](https://docs.talkif.ai/getting-started/quickstart.md): Build a voice agent, talk to it in your browser, publish it, put it on a phone number, and make a real call — in about ten minutes.
- [How a call works](https://docs.talkif.ai/getting-started/how-a-call-works.md): The lifecycle of every Talkif call — from the moment it's triggered to the moment its cost is settled — and what each status, end reason and failure code means.
- [Flows and versions](https://docs.talkif.ai/concepts/flows-and-versions.md): What a flow is made of, the four lifecycle states, what publishing actually creates, and how phone numbers and API calls decide which version to run.
- [Credits and pricing](https://docs.talkif.ai/concepts/credits-and-pricing.md): How Talkif charges — what a call costs and why, the four kinds of balance and the order they're spent in, what happens at zero, and a worked example.
- [Build agents](https://docs.talkif.ai/build.md): The Flow Builder — how to design conversations, write prompts, choose models and voices, call your backend, control how calls end, and test and publish.
- [Design a conversation](https://docs.talkif.ai/build/design-a-conversation.md): How agents, transitions and functions combine into a conversation the LLM can run well — and how to split a job across agents so each one stays simple.
- [Write prompts](https://docs.talkif.ai/build/write-prompts.md): What goes in the System Prompt versus the Agent Prompt, what works on a phone line, the {{variables}} and helpers available, and the Prompts workspace.
- [Choose models and voices](https://docs.talkif.ai/build/choose-models-and-voices.md): How the STT, LLM and TTS choices shape a phone conversation, how to trade latency against quality and cost, and every setting each provider exposes.
- [Call your backend](https://docs.talkif.ai/build/call-your-backend.md): Flow functions let the agent read from and write to your systems mid-conversation — how they're defined, how the LLM uses them, how requests are built, signed and limited, and how to handle failure.
- [Transfer and end calls](https://docs.talkif.ai/build/transfer-and-end-calls.md): How a call ends well — the End Call function, scripted lines with Say, silence handling, a maximum call length, and voicemail on outbound calls.
- [Test and publish](https://docs.talkif.ai/build/test-and-publish.md): Talk to a draft in the browser, understand what validation checks and why, publish a version with notes, compare versions, and roll back.
- [Templates](https://docs.talkif.ai/build/templates.md): Five ready-made flows — reminder, support triage, survey, lead qualification, payment reminder — what each one contains, and how to make one yours.
- [Assistant](https://docs.talkif.ai/build/assistant.md): The in-dashboard AI assistant — chat about your account, build and edit flows, and get help with any part of the platform.
- [Telephony](https://docs.talkif.ai/telephony.md): Phone numbers in Talkif — buying them, bringing your own SIP trunk or Twilio account, WhatsApp Business Calling, routing inbound and outbound calls, and where calls are served from.
- [Buy a number](https://docs.talkif.ai/telephony/buy-a-number.md): Search and buy a phone number inside Talkif — which countries, what it costs, how monthly rental works, what happens when it can't be paid, and how to release a number.
- [Bring your own SIP trunk](https://docs.talkif.ai/telephony/bring-your-own-sip-trunk.md): Keep your existing numbers and carrier — connect a SIP trunk to Talkif. The IP to allowlist, the credentials, the inbound and outbound call paths, protocol and port options, and how to bring numbers from your own Twilio account instead.
- [WhatsApp Business Calling](https://docs.talkif.ai/telephony/whatsapp-business-calling.md): Let your agents answer calls made to your WhatsApp Business number — connect the WABA, register numbers, understand Pending vs Active, and what it costs.
- [Inbound and outbound routing](https://docs.talkif.ai/telephony/inbound-and-outbound-routing.md): How a number decides what answers it, which numbers can place outbound calls and from where, pinning a number to a flow version, per-number recording, and the number statuses and capabilities you'll see.
- [Regions and edges](https://docs.talkif.ai/telephony/regions-and-edges.md): Where Talkif runs, how a call is served from the region nearest the caller, how the carrier edge is chosen for a SIP trunk, and what to allowlist for signalling and media.
- [Run calls](https://docs.talkif.ai/calls.md): Placing single calls, running campaigns and schedules, reading transcripts, recordings and insights, and managing the contacts and Do Not Call list they draw on.
- [Make a call](https://docs.talkif.ai/calls/make-a-call.md): Place a single outbound call from the dashboard or the API, what Talkif checks before dialing, why a request can be refused, and how to follow the call while it runs.
- [Campaigns](https://docs.talkif.ai/calls/campaigns.md): Call a list of contacts with one flow — how contacts are chosen, paced and retried, how call windows and contact timezones work, the campaign lifecycle, auto-pause, and what the analytics tell you.
- [Schedules](https://docs.talkif.ai/calls/schedules.md): Call one contact on a recurrence — once at a set time, daily, weekly, monthly or on a cron expression — with retries, an end date or run cap, and the contact's own timezone.
- [Transcripts and recordings](https://docs.talkif.ai/calls/transcripts-and-recordings.md): Everything a finished call leaves behind — the transcript, the recording and its retention, the cost breakdown, conversation metrics, and AI insights — and how to get each from the dashboard or the API.
- [Contacts](https://docs.talkif.ai/calls/contacts.md): The people your agents call — what a contact record holds, how it feeds prompts and campaigns, tags and segmentation, timezone and language, timelines, and soft deletion.
- [Import contacts](https://docs.talkif.ai/calls/import-contacts.md): Bring contacts in from CSV, JSON or vCard — the columns, phone-number normalisation, the dry-run preview, duplicate handling, and what the summary tells you.
- [Do Not Call](https://docs.talkif.ai/calls/do-not-call.md): A phone-number list that blocks every outbound call to it — how it's checked, how numbers get on it (including callers asking during a call), bulk import, and checking numbers before a campaign.
- [Integrate](https://docs.talkif.ai/integrate.md): The developer surface — API keys, SDKs, webhooks and signature verification, real-time events over WebSocket, idempotency and rate limits, and the Meta Lead Ads integration.
- [Authentication](https://docs.talkif.ai/integrate/authentication.md): API keys for server-to-server access — how they're scoped to an account, creating and using one, permission scopes, IP allowlists and expiry, usage and error tracking, and safe rotation.
- [Webhooks](https://docs.talkif.ai/integrate/webhooks.md): Every request Talkif makes to your servers — flow functions called mid-conversation — can be signed. How to verify the Talkif-Signature header, handle rotation and empty bodies, and what delivery limits apply.
- [Real-time events](https://docs.talkif.ai/integrate/real-time-events.md): Follow calls as they happen from your own systems — a WebSocket stream of call lifecycle events for the account, and per-call transcript, turn, transition and recording events, with replay for late joiners.
- [Idempotency and rate limits](https://docs.talkif.ai/integrate/idempotency-and-rate-limits.md): Retrying requests without placing a call twice, what Talkif rate-limits and at what defaults, how a limited request answers, and how to design an integration that never trips them.
- [Meta Lead Ads](https://docs.talkif.ai/integrate/meta-lead-ads.md): Auto-call Facebook and Instagram leads the moment they submit, and feed call outcomes back to Meta to sharpen ad targeting.
- [Account and billing](https://docs.talkif.ai/account.md): Credits and payment, reading costs, organizations and member roles, security settings, notifications, and taking your data out or closing the account.
- [Credits and payment](https://docs.talkif.ai/account/credits-and-payment.md): Adding money to your balance, cards and their health, auto-recharge and its retry schedule, and what to do when a payment fails.
- [Cost breakdown](https://docs.talkif.ai/account/cost-breakdown.md): Reading what you were charged and why — the Costs view, charges and their statuses, balance transactions, per-call line items — and the handful of levers that actually move the bill.
- [Organizations](https://docs.talkif.ai/account/organizations.md): When one person's account needs to become a team's — what an organization is, what it owns, how it differs from a personal account, and how to create or move to one.
- [Members and roles](https://docs.talkif.ai/account/members-and-roles.md): The three roles in an organization — Owner, Admin, Member — exactly what each may do, how invitations work, and how to suspend, remove or hand over.
- [Security](https://docs.talkif.ai/account/security.md): Your profile and verification status, password and Google sign-in, two-factor authentication with backup codes, and ending sessions on other devices.
- [Notifications](https://docs.talkif.ai/account/notifications.md): What Talkif tells you about — billing, calls, security, organization — where it appears, and the low-balance threshold you should set.
- [Data export and deletion](https://docs.talkif.ai/account/data-export-and-deletion.md): Take everything out of Talkif as one JSON file, and close an account with a confirmation step and a seven-day grace period.
- [Limits](https://docs.talkif.ai/reference/limits.md): Every default limit in one place — concurrency, queue depth, call rate, queue time-to-live and priority, per-request caps, and what happens at each ceiling.
- [Models and voices](https://docs.talkif.ai/reference/models-and-voices.md): Every speech-to-text, language and text-to-speech model Talkif offers, with languages, features and current per-unit prices — generated from the live catalogue.
- [Network and IP allowlists](https://docs.talkif.ai/reference/network-and-ip-allowlists.md): Every address involved in traffic between Talkif and your systems — SIP signalling, media, and the egress addresses Talkif's requests to your endpoints come from — and what to allowlist for each.
- [Error Codes](https://docs.talkif.ai/api-reference/errors.md): Complete reference of API error codes and field validation errors returned by the Talkif API.
- [SDKs](https://docs.talkif.ai/sdks/server.md): Official TypeScript/Node.js and Python clients for the Talkif API — install, authenticate, place a call, page through results, handle errors.
- [Web calls](https://docs.talkif.ai/sdks/browser.md): Put a voice agent on any web page — the browser SDK, publishable keys and origin allowlists, the two modes, events you can render live, and the abuse limits that make an unauthenticated call endpoint safe.
- [Build with AI agents](https://docs.talkif.ai/skills/agent-skills.md): Use Claude Code, Codex, Cursor or any agent that reads Agent Skills to build on Talkif — install the official skills, what each one teaches, and how these docs are served to agents.
- [Changelog](https://docs.talkif.ai/changelog/llms.txt)

## API Docs

- API Reference > Billing [Get balance summary](https://docs.talkif.ai/api-reference/billing/get-balance-summary.md)
- API Reference > Billing [List charges](https://docs.talkif.ai/api-reference/billing/list-charges.md)
- API Reference > Billing [Get charge detail](https://docs.talkif.ai/api-reference/billing/get-charge-detail.md)
- API Reference > Billing [Get cost breakdown](https://docs.talkif.ai/api-reference/billing/get-billing-cost-breakdown.md)
- API Reference > Billing [Get call cost breakdown](https://docs.talkif.ai/api-reference/billing/get-billing-call-cost-breakdown.md)
- API Reference > Billing [List invoices](https://docs.talkif.ai/api-reference/billing/list-invoices.md)
- API Reference > Billing [Get invoice](https://docs.talkif.ai/api-reference/billing/get-invoice.md)
- API Reference > Billing [Get transaction history](https://docs.talkif.ai/api-reference/billing/get-transaction-history.md)
- API Reference > Billing [Get public pricing](https://docs.talkif.ai/api-reference/billing/get-public-pricing.md)
- API Reference > Calls [List calls](https://docs.talkif.ai/api-reference/calls/list-calls.md)
- API Reference > Calls [Initiate a call](https://docs.talkif.ai/api-reference/calls/make-call.md)
- API Reference > Calls [Get call details](https://docs.talkif.ai/api-reference/calls/get-call-details.md)
- API Reference > Calls [Analyze call](https://docs.talkif.ai/api-reference/calls/analyze-call.md)
- API Reference > Calls [Get call recording URL](https://docs.talkif.ai/api-reference/calls/get-call-recording.md)
- API Reference > Calls [Delete a call recording from S3.](https://docs.talkif.ai/api-reference/calls/delete-call-recording.md)
- API Reference > Calls [Get call transcript](https://docs.talkif.ai/api-reference/calls/get-call-transcript.md)
- API Reference > Campaigns [List campaigns](https://docs.talkif.ai/api-reference/campaigns/list-campaigns.md)
- API Reference > Campaigns [Create campaign](https://docs.talkif.ai/api-reference/campaigns/create-campaign.md)
- API Reference > Campaigns [Get campaign](https://docs.talkif.ai/api-reference/campaigns/get-campaign.md)
- API Reference > Campaigns [Update campaign](https://docs.talkif.ai/api-reference/campaigns/update-campaign.md)
- API Reference > Campaigns [Delete campaign](https://docs.talkif.ai/api-reference/campaigns/delete-campaign.md)
- API Reference > Campaigns [Cancel campaign](https://docs.talkif.ai/api-reference/campaigns/cancel-campaign.md)
- API Reference > Campaigns [List campaign contacts](https://docs.talkif.ai/api-reference/campaigns/list-campaign-contacts.md)
- API Reference > Campaigns [Add campaign contacts](https://docs.talkif.ai/api-reference/campaigns/add-campaign-contacts.md)
- API Reference > Campaigns [Remove campaign contacts](https://docs.talkif.ai/api-reference/campaigns/remove-campaign-contacts.md)
- API Reference > Campaigns [Bulk add campaign contacts](https://docs.talkif.ai/api-reference/campaigns/bulk-add-campaign-contacts.md)
- API Reference > Campaigns [Bulk remove campaign contacts](https://docs.talkif.ai/api-reference/campaigns/bulk-remove-campaign-contacts.md)
- API Reference > Campaigns [Skip campaign contact](https://docs.talkif.ai/api-reference/campaigns/skip-campaign-contact.md)
- API Reference > Campaigns [Pause campaign](https://docs.talkif.ai/api-reference/campaigns/pause-campaign.md)
- API Reference > Campaigns [Restart campaign](https://docs.talkif.ai/api-reference/campaigns/restart-campaign.md)
- API Reference > Campaigns [Resume campaign](https://docs.talkif.ai/api-reference/campaigns/resume-campaign.md)
- API Reference > Campaigns [Start campaign](https://docs.talkif.ai/api-reference/campaigns/start-campaign.md)
- API Reference > Analytics [Get campaign analytics](https://docs.talkif.ai/api-reference/analytics/get-campaign-analytics.md)
- API Reference > Analytics [Get flow stats](https://docs.talkif.ai/api-reference/analytics/get-flow-stats.md)
- API Reference > Contacts [List contacts](https://docs.talkif.ai/api-reference/contacts/list-contacts.md)
- API Reference > Contacts [Create contact](https://docs.talkif.ai/api-reference/contacts/create-contact.md)
- API Reference > Contacts [Export contacts](https://docs.talkif.ai/api-reference/contacts/export-contacts.md)
- API Reference > Contacts [Import contacts](https://docs.talkif.ai/api-reference/contacts/import-contacts.md)
- API Reference > Contacts [Search contact by phone](https://docs.talkif.ai/api-reference/contacts/search-by-phone.md)
- API Reference > Contacts [List contact tags](https://docs.talkif.ai/api-reference/contacts/list-tags.md)
- API Reference > Contacts [Get contact](https://docs.talkif.ai/api-reference/contacts/get-contact.md)
- API Reference > Contacts [Update contact](https://docs.talkif.ai/api-reference/contacts/update-contact.md)
- API Reference > Contacts [Delete contact](https://docs.talkif.ai/api-reference/contacts/delete-contact.md)
- API Reference > Contacts [List contact call timeline](https://docs.talkif.ai/api-reference/contacts/get-contact-calls.md)
- API Reference > Contacts [Restore contact](https://docs.talkif.ai/api-reference/contacts/restore-contact.md)
- API Reference > Contacts [Add tags to contact](https://docs.talkif.ai/api-reference/contacts/add-tags.md)
- API Reference > Contacts [Remove tags from contact](https://docs.talkif.ai/api-reference/contacts/remove-tags.md)
- API Reference > Do Not Call [List DNC entries](https://docs.talkif.ai/api-reference/do-not-call/list-dnc-entries.md)
- API Reference > Do Not Call [Add DNC entry](https://docs.talkif.ai/api-reference/do-not-call/add-dnc-entry.md)
- API Reference > Do Not Call [Bulk import DNC entries](https://docs.talkif.ai/api-reference/do-not-call/bulk-import-dnc.md)
- API Reference > Do Not Call [Check DNC status](https://docs.talkif.ai/api-reference/do-not-call/check-dnc-status.md)
- API Reference > Do Not Call [Remove DNC entry](https://docs.talkif.ai/api-reference/do-not-call/remove-dnc-entry.md)
- API Reference > Errors [Get error code catalog](https://docs.talkif.ai/api-reference/errors/error-catalog.md)
- API Reference > Flow Functions [List flow functions](https://docs.talkif.ai/api-reference/flow-functions/list-flow-functions.md)
- API Reference > Flow Functions [Create a flow function](https://docs.talkif.ai/api-reference/flow-functions/create-flow-function.md)
- API Reference > Flow Functions [Get a flow function](https://docs.talkif.ai/api-reference/flow-functions/get-flow-function.md)
- API Reference > Flow Functions [Update a flow function](https://docs.talkif.ai/api-reference/flow-functions/update-flow-function.md)
- API Reference > Flow Functions [Delete a flow function](https://docs.talkif.ai/api-reference/flow-functions/delete-flow-function.md)
- API Reference > Flow Templates [List system templates](https://docs.talkif.ai/api-reference/flow-templates/list-system-templates.md)
- API Reference > Flow Templates [Get template by slug](https://docs.talkif.ai/api-reference/flow-templates/get-flow-template.md)
- API Reference > Flow Templates [Create flow from template](https://docs.talkif.ai/api-reference/flow-templates/instantiate-template.md)
- API Reference > Flows [List flows](https://docs.talkif.ai/api-reference/flows/list-flows.md)
- API Reference > Flows [Create flow](https://docs.talkif.ai/api-reference/flows/create-flow.md)
- API Reference > Flows [Get flow](https://docs.talkif.ai/api-reference/flows/get-flow.md)
- API Reference > Flows [Update flow](https://docs.talkif.ai/api-reference/flows/update-flow.md)
- API Reference > Flows [Delete flow](https://docs.talkif.ai/api-reference/flows/delete-flow.md)
- API Reference > Flows [Publish flow](https://docs.talkif.ai/api-reference/flows/publish-flow.md)
- API Reference > Flows [Rollback flow to version](https://docs.talkif.ai/api-reference/flows/rollback-flow.md)
- API Reference > Flows [Validate flow](https://docs.talkif.ai/api-reference/flows/validate-flow.md)
- API Reference > Flows [Get flow version](https://docs.talkif.ai/api-reference/flows/get-flow-version.md)
- API Reference > AI Models [List all providers (public)](https://docs.talkif.ai/api-reference/ai-models/list-providers-public.md)
- API Reference > AI Models [List TTS voices](https://docs.talkif.ai/api-reference/ai-models/list-tts-voices.md)
- API Reference > Phone Numbers [List phone numbers](https://docs.talkif.ai/api-reference/phone-numbers/list-phone-numbers.md)
- API Reference > Phone Numbers [List available numbers to purchase](https://docs.talkif.ai/api-reference/phone-numbers/list-available-numbers.md)
- API Reference > Phone Numbers [List available countries for purchase](https://docs.talkif.ai/api-reference/phone-numbers/list-available-countries.md)
- API Reference > Phone Numbers [Get phone number pricing](https://docs.talkif.ai/api-reference/phone-numbers/get-pricing.md)
- API Reference > Phone Numbers [Purchase phone number](https://docs.talkif.ai/api-reference/phone-numbers/purchase-phone-number.md)
- API Reference > Phone Numbers [Get phone number](https://docs.talkif.ai/api-reference/phone-numbers/get-phone-number.md)
- API Reference > Phone Numbers [Update phone number](https://docs.talkif.ai/api-reference/phone-numbers/update-phone-number.md)
- API Reference > Phone Numbers [Release phone number](https://docs.talkif.ai/api-reference/phone-numbers/release-phone-number.md)
- API Reference > Phone Numbers [Connect flow to phone number](https://docs.talkif.ai/api-reference/phone-numbers/connect-flow.md)
- API Reference > Phone Numbers [Disconnect flow from phone number](https://docs.talkif.ai/api-reference/phone-numbers/disconnect-flow.md)
- API Reference > Phone Providers [List phone providers](https://docs.talkif.ai/api-reference/phone-providers/list-phone-providers.md)
- API Reference > Phone Providers [Get phone provider](https://docs.talkif.ai/api-reference/phone-providers/get-provider.md)
- API Reference > Public Calls [Create public WebRTC call](https://docs.talkif.ai/api-reference/public-calls/create-call.md)
- API Reference > Public Calls [Get public call status](https://docs.talkif.ai/api-reference/public-calls/get-call-status.md)
- API Reference > Public Calls [Relay public WebRTC offer](https://docs.talkif.ai/api-reference/public-calls/relay-offer.md)
- API Reference > Public Calls [Get public ICE servers](https://docs.talkif.ai/api-reference/public-calls/get-ice-servers.md)
- API Reference > Public Calls [Create public call session](https://docs.talkif.ai/api-reference/public-calls/create-session.md)
- API Reference > Schedules [List schedules](https://docs.talkif.ai/api-reference/schedules/list-schedules.md)
- API Reference > Schedules [Create schedule](https://docs.talkif.ai/api-reference/schedules/create-schedule.md)
- API Reference > Schedules [Get schedule](https://docs.talkif.ai/api-reference/schedules/get-schedule.md)
- API Reference > Schedules [Update schedule](https://docs.talkif.ai/api-reference/schedules/update-schedule.md)
- API Reference > Schedules [Delete schedule](https://docs.talkif.ai/api-reference/schedules/delete-schedule.md)
- API Reference > Schedules [Pause schedule](https://docs.talkif.ai/api-reference/schedules/pause-schedule.md)
- API Reference > Schedules [Resume schedule](https://docs.talkif.ai/api-reference/schedules/resume-schedule.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.talkif.ai/openapi.json)
- [OpenAPI YAML](https://docs.talkif.ai/openapi.yaml)