# TalkifAI

## Docs

- [Authentication](https://docs.talkifai.dev/api-reference/authentication.md): Session-based and API key authentication for the TalkifAI API.
- [Create Chat Session](https://docs.talkifai.dev/api-reference/chat/create-session.md): Create a new text chat session. Returns session token, conversation ID, and greeting message.
- [Create Voice Session](https://docs.talkifai.dev/api-reference/chat/create-voice-session.md): Create a LiveKit voice session for real-time voice conversations with your agent.
- [End Session](https://docs.talkifai.dev/api-reference/chat/end-session.md): End a chat session and trigger cleanup: billing finalization, memory ingestion, post-call analysis, and webhooks.
- [Get Message History](https://docs.talkifai.dev/api-reference/chat/get-history.md): Retrieve paginated message history for a chat session. Useful for resuming conversations or page refreshes.
- [Chat API Reference](https://docs.talkifai.dev/api-reference/chat/overview.md): Complete API reference for the TalkifAI Text Chat API — embed text-based AI agents on any website.
- [Send Message (SSE)](https://docs.talkifai.dev/api-reference/chat/send-message.md): Send a message and receive streamed response via Server-Sent Events (SSE).
- [Custom Functions](https://docs.talkifai.dev/api-reference/custom-functions.md): Create and manage custom API integrations that agents call in real-time during conversations.
- [Cancel Batch Job](https://docs.talkifai.dev/api-reference/endpoint/cancel-batch-job.md): Cancel a scheduled, pending, or running batch job. Stops new calls and marks remaining contacts as cancelled.
- [Create Agent](https://docs.talkifai.dev/api-reference/endpoint/create-agent.md): Creates a new agent. Choose from Pipeline (voice + text), Realtime (lowest latency), or Text (chat only) architecture.
- [Create Batch Job](https://docs.talkifai.dev/api-reference/endpoint/create-batch-job.md): Create a new batch calling job by uploading a CSV file or sending contacts via JSON.
- [Delete Agent](https://docs.talkifai.dev/api-reference/endpoint/delete-agent.md): Permanently deletes an agent. This action cannot be undone.
- [Export Conversation](https://docs.talkifai.dev/api-reference/endpoint/export-conversation.md): Export complete conversation data including transcript, post-call analysis, and recording URL. Returns a downloadable JSON file.
- [Get Agent](https://docs.talkifai.dev/api-reference/endpoint/get-agent.md): Returns full configuration details for a specific agent. Returns 403 if the agent is private and the caller is not its creator or an org admin/owner.
- [Get Batch Job Detail](https://docs.talkifai.dev/api-reference/endpoint/get-batch-job.md): Get complete details of a batch calling job including progress stats, timing info, and paginated contacts.
- [Initiate Outbound Call](https://docs.talkifai.dev/api-reference/endpoint/initiate-call.md): Triggers an outbound voice call from your registered phone number to a destination.
- [List Agents](https://docs.talkifai.dev/api-reference/endpoint/list-agents.md): Returns all agents in your current organization. Access is scoped by user role — owners/admins see all agents, members see public agents plus their own private agents.
- [List Batch Jobs](https://docs.talkifai.dev/api-reference/endpoint/list-batch-jobs.md): Returns a paginated list of batch calling jobs for your organization.
- [Get Redis Job Status](https://docs.talkifai.dev/api-reference/endpoint/redis-status.md): Get Redis job status for debugging scheduled batch jobs. Verifies if job exists in Redis defer queue.
- [Reschedule Batch Job](https://docs.talkifai.dev/api-reference/endpoint/reschedule-batch-job.md): Reschedule a scheduled or pending batch job to a new start time.
- [Start Batch Job Immediately](https://docs.talkifai.dev/api-reference/endpoint/start-batch-job.md): Manually start a scheduled or pending batch job immediately, bypassing the scheduled start time.
- [Update Agent](https://docs.talkifai.dev/api-reference/endpoint/update-agent.md): Updates one or more fields on an agent. Only send the fields you want to change. Architecture cannot be changed after creation.
- [API Introduction](https://docs.talkifai.dev/api-reference/introduction.md): TalkifAI REST API — build voice agent workflows programmatically.
- [Webhooks](https://docs.talkifai.dev/api-reference/webhooks.md): Receive real-time events when calls start, end, and more.
- [Billing System](https://docs.talkifai.dev/architecture/billing.md): Credit-based billing architecture — how usage is tracked and charged.
- [Architecture Overview](https://docs.talkifai.dev/architecture/overview.md): High-level technical architecture of the TalkifAI platform.
- [Security Architecture](https://docs.talkifai.dev/architecture/security.md): Authentication, encryption, multi-tenant isolation, and security best practices.
- [Voice Agent Runtime](https://docs.talkifai.dev/architecture/voice-runtime.md): Deep dive into the Python/LiveKit voice agent runtime backend.
- [BYOC (Bring Your Own Carrier)](https://docs.talkifai.dev/guides/byoc.md): Connect your existing SIP infrastructure to TalkifAI voice agents.
- [Text Chat API](https://docs.talkifai.dev/guides/chat-api.md): Embed a text-based AI chat widget on any website using TalkifAI's REST API. No LiveKit or WebRTC required.
- [Custom Functions](https://docs.talkifai.dev/guides/custom-functions.md): Give your voice agent access to your own APIs using custom function webhooks.
- [Noise Cancellation](https://docs.talkifai.dev/guides/noise-cancellation.md): Enable RNNoise-based audio noise cancellation for cleaner voice quality.
- [TalkifAI Widget Integration Guide](https://docs.talkifai.dev/guides/widget-integration.md): Complete guide to integrating the TalkifAI chat widget on your website — supports both text chat and voice conversations.
- [What is TalkifAI?](https://docs.talkifai.dev/introduction.md): Build and deploy AI voice agents in minutes — no code required.
- [Advanced Agent Configuration](https://docs.talkifai.dev/platform/advanced-configuration.md): Master advanced agent settings including webhooks, farewell messages, function calling API, multi-language support, greeting configuration, and inactivity timeout.
- [Agent Architectures](https://docs.talkifai.dev/platform/agent-architectures.md): Pipeline, Realtime, or Text — understand the three agent types and when to use each.
- [Testing Your Agent](https://docs.talkifai.dev/platform/agent-testing.md): How to properly test your agent before going live — checklists, scenarios, and red flags.
- [Analytics & Call Logs](https://docs.talkifai.dev/platform/analytics.md): Track call performance, monitor usage credits, and analyze conversation quality with TalkifAI's built-in analytics.
- [API Key Management](https://docs.talkifai.dev/platform/api-keys.md): Create and manage API keys for programmatic access to TalkifAI APIs. Choose between Secret Keys for server-side use and Widget Keys for browser-safe embeds.
- [Batch Calling](https://docs.talkifai.dev/platform/batch-calling.md): Run automated outbound call campaigns at scale with Redis-backed job queues, CSV upload, and real-time analytics.
- [Billing & Credits](https://docs.talkifai.dev/platform/billing.md): Understand how TalkifAI billing works, manage your credits, and optimize costs across voice and text agent usage.
- [Billing & Credits](https://docs.talkifai.dev/platform/billing-credits.md): Manage your organization's credits, view transaction history, and add funds via Lemon Squeezy.
- [Create an Agent](https://docs.talkifai.dev/platform/create-agent.md): Step-by-step guide — build your first AI voice agent in under 10 minutes.
- [Knowledge Base Integration](https://docs.talkifai.dev/platform/knowledge-base.md): Give your agent access to your documents, FAQs, and company data using RAG (Retrieval Augmented Generation).
- [Managing Agents](https://docs.talkifai.dev/platform/managing-agents.md): View, test, edit, and manage your voice AI agents from the Studio dashboard.
- [Commercial Agents & Marketplace](https://docs.talkifai.dev/platform/marketplace.md): Publish your agents to the marketplace and monetize your AI creations — or discover pre-built agents for your business.
- [Conversation Memory](https://docs.talkifai.dev/platform/memory.md): Enable long-term memory so your agent remembers users across multiple conversations using Graphiti's knowledge graph.
- [Organization & Team Management](https://docs.talkifai.dev/platform/organization.md): Manage your TalkifAI organization, invite team members, assign roles, and control access to agents and resources.
- [Platform Overview](https://docs.talkifai.dev/platform/overview.md): Understand TalkifAI's core concepts — organizations, agents, and sessions.
- [Post-Call Analysis](https://docs.talkifai.dev/platform/post-call-analysis.md): Automatically analyze call quality, extract insights, and ensure compliance with customizable AI-powered evaluation forms.
- [Pronunciation Management](https://docs.talkifai.dev/platform/pronunciation.md): Control how your agent pronounces specific words, brand names, and technical terms using custom phoneme dictionaries.
- [Settings & Profile](https://docs.talkifai.dev/platform/settings-profile.md): Manage your profile, notifications, security settings, and integrations.
- [Subagents & Multi-Agent Hierarchy](https://docs.talkifai.dev/platform/subagents.md): Build complex agent workflows with multiple specialized subagents — each handling specific tasks within a conversation.
- [System Prompt Guide](https://docs.talkifai.dev/platform/system-prompt-guide.md): Learn how to write effective system prompts — the single biggest factor in your agent's performance.
- [Telephony](https://docs.talkifai.dev/platform/telephony.md): Connect phone numbers to your agents for inbound and outbound calling.
- [Voice Selection](https://docs.talkifai.dev/platform/voices.md): The right voice makes your agent sound professional and trustworthy from the first word.
- [Quick Start](https://docs.talkifai.dev/quickstart.md): Create your first AI voice agent in under 5 minutes.

## OpenAPI Specs

- [openapi](https://docs.talkifai.dev/openapi.json)

## Optional

- [Dashboard](https://studio.talkifai.dev/agents)
- [LinkedIn](https://www.linkedin.com/company/talkifai-dev/)
- [Status](https://status.talkifai.dev/)