# Documentation

- [Documentation](/docs): Build powerful AI voice agents with OmniDimension. Guides, API reference, and integration recipes for the entire platform.

- **Get started**
- [Quickstart](/docs/get-started/quickstart): Install the OmniDimension Python SDK, configure your API key, and run your first request in five minutes.
- [Authentication](/docs/get-started/authentication): How to obtain an OmniDimension API key and configure it for the SDK.

- **Build**
- Dashboard guides
  - [Dashboard guides](/docs/dashboard-guides): No-code walkthroughs for configuring agents, numbers, knowledge base, and post-call delivery from the OmniDimension dashboard.
  - [Configure your agent](/docs/dashboard-guides/configure-your-agent): Configure the conversational flow for your agent. Sections, instructions, welcome message, and best practices.
  - [Voices and languages](/docs/dashboard-guides/voices-and-languages): Build globally-aware AI agents with native-level fluency across 90+ languages and 1000+ realistic voices.
  - [Numbers Shop](/docs/dashboard-guides/numbers-shop): Purchase dedicated phone numbers and connect them to your Voice AI agents.
  - [Knowledge base](/docs/dashboard-guides/knowledge-base): Provide your agent with domain-specific knowledge using document-based references.
  - [Post-call actions](/docs/dashboard-guides/post-call): Configure post-call delivery to Email, Salesforce, Slack, Webhooks, HubSpot, and WhatsApp Cloud.
  - [Recent calls](/docs/dashboard-guides/recent-calls): Access, analyze, and make use of recent call logs to improve your agent's performance.
  - [Web chat widget](/docs/dashboard-guides/web-chat-widget): Deploy your voice AI agent as a chat widget on your website with a no-code embed script.
  - [Voice cloning](/docs/dashboard-guides/voice-cloning): Clone your voice and use it with your AI agents for a personalized experience.
  - [Web search tool](/docs/dashboard-guides/web-search-tool): Enable real-time internet access for your agent using the Web Search integration.
  - [Agent timezone](/docs/dashboard-guides/update-timezone): Set and update your agent's timezone for accurate scheduling and time-based operations.

- **Connect**
- Bulk calls
  - [Bulk calls](/docs/bulk-calls): Run AI-powered outbound campaigns with retry logic, dynamic queues, and best practices for production deployment.
  - [Bulk Call Campaign Guide](/docs/bulk-calls/overview): Complete step-by-step guide to create and manage AI-powered bulk call campaigns to reach multiple contacts efficiently.
  - [Dynamic Campaign Guide](/docs/bulk-calls/dynamic): Create a Dynamic Campaign that accepts contacts in real time via a webhook API. Ideal for CRM integrations and continuous outreach.
  - [Bulk Outbound Call Best Practices](/docs/bulk-calls/best-practices): Complete guide for optimizing bulk call campaigns, from agent configuration to post-call analysis.
- Telephony
  - [Telephony](/docs/telephony): Bring your own phone numbers to OmniDimension. Any SIP-enabled carrier works, with fast-path guides for the most common ones.
  - [SIP Trunking](/docs/telephony/sip): Connect your existing phone numbers to OmniDimension using SIP trunking.
  - [Import Exotel Phone Numbers](/docs/telephony/exotel-import): Seamlessly integrate your Exotel phone numbers with OmniDimension and set up intelligent call flows for your AI agents.
  - [RingCentral SIP Configuration](/docs/telephony/sip-ringcentral): Complete guide to configure your RingCentral SIP trunking, including SIP credentials and optional outbound proxy.
  - [Twilio SIP Configuration](/docs/telephony/sip-twilio): Complete guide to configure your Twilio Elastic SIP Trunking with credential lists or IP ACL authentication.
  - [Vonage SIP Setup](/docs/telephony/sip-vonage): Complete guide to configure your Vonage SIP trunking with UserKey and Secret authentication.
- WhatsApp
  - [WhatsApp Integration](/docs/whatsapp): Connect your WhatsApp Business account to send and receive messages, automate responses with bots, and manage campaigns.
- Integrations
  - [Integrations](/docs/integrations): Connect OmniDimension to anything. Custom API turns any REST endpoint into an agent action, plus prebuilt connectors for the platforms you already use.
  - [Custom API](/docs/integrations/custom-api): Connect your agent to any external service using custom API integration.
  - [Make, Zapier, n8n, GHL](/docs/integrations/zapier-make-n8n): Integrate Make, Zapier, n8n, and GHL with your OmniDimension agent for powerful automation.
  - [Salesforce](/docs/integrations/salesforce): Connect your Salesforce CRM with your voice AI agent to manage contacts, leads, and opportunities.
  - [Cal.com](/docs/integrations/cal-com): Integrate Cal.com with your voice AI agent for seamless meeting scheduling.
  - [Google Calendar](/docs/integrations/google-calendar): Integrate Google Calendar with your agent to schedule and manage meetings automatically.
  - [HubSpot](/docs/integrations/hubspot): Integrate HubSpot with your voice AI agent to automatically manage contacts, deals, and more.
  - [Slack](/docs/integrations/slack): Send automated messages and notifications from your voice AI agent into your Slack workspace.

- **Client SDKs**
- Client SDKs
  - [Client SDKs](/docs/sdks): Official OmniDimension SDKs for calling the API from your stack.
  - [Python SDK](/docs/sdks/python): The omnidimension Python package. Install with pip and start calling the API.

- **Reference**
- API reference
  - [API reference](/docs/api-reference): REST + Python SDK reference for the OmniDimension platform with an interactive try-it-out playground.
  - Agents: Create, retrieve, update, and delete AI voice agents. Configure
transcriber, model, voice, integrations, and post-call actions.
    - [List agents](/docs/api-reference/agents/listAgents): Retrieve all agents for the authenticated user with pagination support.
    - [Create agent](/docs/api-reference/agents/createAgent): Create a new agent with the provided configuration. The full
config supports transcriber, model, voice, web search, transfer,
end-call conditions, post-call actions (email + webhook),
ambient background track, initial ringing sound, and multilingual support.
    - [Get agent](/docs/api-reference/agents/getAgent): Get details of a specific agent by ID.
    - [Delete agent](/docs/api-reference/agents/deleteAgent): Permanently delete an agent.
    - [Update agent](/docs/api-reference/agents/updateAgent): Update an existing agent. Send only the fields you want to change.
  - Calls: Dispatch calls to phone numbers, retrieve call logs, and inspect
individual call sessions.
    - [Dispatch call](/docs/api-reference/calls/dispatchCall): Initiate a call to a phone number using a specified agent. The
phone number must include a country code with a leading plus.
    - [List call logs](/docs/api-reference/calls/listCallLogs): Retrieve call logs with pagination and optional filtering.
    - [Get call log](/docs/api-reference/calls/getCallLog): Detailed information about a specific call (duration, status, transcript, sentiment, extracted variables).
  - Bulk calls: Run outbound campaigns against a contact list. Schedule, retry,
pause, resume, and monitor live status.
    - [Fetch bulk calls](/docs/api-reference/bulk-calls/fetchBulkCalls): List bulk-call campaigns with pagination and optional status filter.
    - [Create bulk call](/docs/api-reference/bulk-calls/createBulkCall): Create a new bulk-call campaign. Supports immediate, scheduled, and auto-retry modes.
    - [Bulk call details](/docs/api-reference/bulk-calls/getBulkCall): Get detailed information about a bulk-call campaign.
    - [Cancel bulk call](/docs/api-reference/bulk-calls/cancelBulkCall): Cancel a bulk-call campaign.
    - [Bulk call actions](/docs/api-reference/bulk-calls/bulkCallActions): Pause, resume, or reschedule a running campaign.
    - [Bulk call live status](/docs/api-reference/bulk-calls/getBulkCallLiveStatus): Real-time status of a running bulk-call campaign.
  - Knowledge base: Upload, manage, and attach PDF documents to agents.
    - [List knowledge base files](/docs/api-reference/knowledge-base/listKnowledgeBaseFiles): List all knowledge-base files for the authenticated user.
    - [Check file upload capability](/docs/api-reference/knowledge-base/canUploadFile): Check whether a file can be uploaded based on size and type.
    - [Upload file to knowledge base](/docs/api-reference/knowledge-base/uploadKnowledgeBaseFile): Upload a PDF file. The file content must be Base64 encoded.
    - [Attach files to agent](/docs/api-reference/knowledge-base/attachKnowledgeBaseFiles): Attach multiple knowledge-base files to an agent.
    - [Detach files from agent](/docs/api-reference/knowledge-base/detachKnowledgeBaseFiles): Detach multiple knowledge-base files from an agent.
    - [Delete file from knowledge base](/docs/api-reference/knowledge-base/deleteKnowledgeBaseFile): Permanently delete a file. Removes it from any attached agents. Cannot be undone.
  - Phone numbers: Manage phone numbers, attach and detach from agents, import from
Twilio, Exotel, or your own SIP trunk.
    - [List phone numbers](/docs/api-reference/phone-numbers/listPhoneNumbers): Retrieve all phone numbers associated with your account.
    - [Attach phone number to agent](/docs/api-reference/phone-numbers/attachPhoneNumber): Attach an account-owned phone number to an existing agent.
    - [Detach phone number](/docs/api-reference/phone-numbers/detachPhoneNumber): Detach a phone number from its associated agent.
    - [Import Twilio number](/docs/api-reference/phone-numbers/importTwilioNumber): Import an existing Twilio number by providing your Twilio credentials.
    - [Import Exotel number](/docs/api-reference/phone-numbers/importExotelNumber): Import an Exotel number by providing your Exotel credentials.
    - [Import SIP trunk](/docs/api-reference/phone-numbers/importSipTrunk): Import a phone number associated with a SIP trunk.
  - Providers: Discover available LLM, voice, STT, and TTS providers, with
advanced filtering for ElevenLabs voices.
    - [List LLM providers](/docs/api-reference/providers/listLLMProviders): Retrieve all available Large Language Model providers.
    - [List voices](/docs/api-reference/providers/listVoices): Retrieve voices with filtering and pagination support. ElevenLabs
supports advanced filtering by name, language, accent, and gender.
Other providers support basic pagination only.
    - [List STT providers](/docs/api-reference/providers/listSTTProviders): Retrieve all Speech-to-Text providers.
    - [List TTS providers](/docs/api-reference/providers/listTTSProviders): Retrieve all Text-to-Speech providers.
    - [List all providers](/docs/api-reference/providers/listAllProviders): Comprehensive response with services and voices in one payload.
    - [Get voice details](/docs/api-reference/providers/getVoice): Detailed metadata for a specific voice.
  - Simulation: Run automated agent test simulations with scenarios and quick-test
workflows.
    - [List simulations](/docs/api-reference/simulation/listSimulations): Retrieve simulations with pagination.
    - [Create simulation](/docs/api-reference/simulation/createSimulation): Create a new test simulation with scenarios.
    - [Get simulation](/docs/api-reference/simulation/getSimulation): Detailed simulation information.
    - [Delete simulation](/docs/api-reference/simulation/deleteSimulation): Permanently delete a simulation.
    - [Update simulation](/docs/api-reference/simulation/updateSimulation): Update an existing simulation. Pass the full `scenarios` array (existing entries you want to keep plus any changes).
    - [Start simulation](/docs/api-reference/simulation/startSimulation): Begin running a simulation. Optionally update scenarios at start time (same shape as Update simulation).
    - [Stop simulation](/docs/api-reference/simulation/stopSimulation): Stop a running simulation.
    - [Enhance prompt](/docs/api-reference/simulation/enhancePrompt): Generate prompt-improvement suggestions for a completed simulation.
- Examples
  - [Examples](/docs/examples): Real-world voice agent builds you can learn from and adapt. Healthcare, real estate, support, recruiting, and more.
  - [Healthcare appointment booking](/docs/examples/health-appointment): Build a voice agent for healthcare appointment scheduling, doctor availability, and clinic info.
  - [Real estate agent (API)](/docs/examples/real-estate): Build a voice agent that handles property inquiries, schedules viewings, and manages client interactions via the API.
  - [SaaS OmniSupport agent](/docs/examples/omnisupport-agent): Build a voice AI agent for SaaS support with Cal.com, Slack, and Make.com integrations.
  - [Recruitment screening bot](/docs/examples/recruit-bot): Build an outbound voice agent for initial job applicant screening calls, with bulk call campaigns.
  - [Restaurant agent (API)](/docs/examples/restaurant): Build a voice agent that handles restaurant orders, reservations, and outbound marketing campaigns.
  - [Utility bill payment agent (API)](/docs/examples/utility-bill-payment): Build an outbound voice agent that handles utility bill payments, sends payment reminders, and manages customer interactions.
  - [Insurance claim status and filing](/docs/examples/insurance-claim-status): Build a voice agent that handles insurance claim status checks, new claim filing, and customer inquiries.
  - [Travel planning and lead generation](/docs/examples/travel-planning-agent): Build an engaging voice agent that helps users plan trips while collecting lead information for your travel business.
- Tutorials
  - [Tutorials](/docs/tutorials): Video walkthroughs for building, configuring, and integrating OmniDimension voice agents.