# AI Phone Agent Docs

## Docs

- [Contacts](https://vida.io/docs/agents/contacts.md): Information on Vida's contact syncing capabilities and how contacts influence how calls and messages are handled.
- [Enabling SMS](https://vida.io/docs/agents/enable-sms.md): Enable SMS capabilities on your Vida AI phone agent by registering your Brand and Texting Campaign with Carriers.
- [Functions](https://vida.io/docs/agents/functions.md): Turbo charge your Vida AI phone agent with functions like webhooks, scheduling, call transfer, and more.
- [Greeting](https://vida.io/docs/agents/greeting.md): Tips on configuring how your Agent answers the phone or starts web conversations.
- [Instructions](https://vida.io/docs/agents/instructions.md): Tips on how to instruct your agent to handle your calls like a pro.
- [Introduction](https://vida.io/docs/agents/intro.md): Details on your Vida Agent including examples for a variety of objectives and use-cases.
- [Language](https://vida.io/docs/agents/language.md): Configure the language your Vida AI phone agent understands.
- [Links](https://vida.io/docs/agents/links.md): Give your AI phone agent access to external information on the web.
- [Voice](https://vida.io/docs/agents/voice.md): Information on HD Text-to-Speech Voices available for your Vida phone agent.
- [Create a new account](https://vida.io/docs/api-reference/accounts/create-a-new-account.md): Create a new account under your organization
- [Create a new organization](https://vida.io/docs/api-reference/accounts/create-a-new-organization.md): Creates an organization under your reseller account (reseller auth required).
- [Create a new reseller](https://vida.io/docs/api-reference/accounts/create-a-new-reseller.md): Create a new reseller under your partner account. Partner account required.
- [Delete an account](https://vida.io/docs/api-reference/accounts/delete-an-account.md): Delete an account under your organization
- [Delete an organization](https://vida.io/docs/api-reference/accounts/delete-an-organization.md): Delete (immediately) an organization under your reseller. Reseller account required.
- [Delete member](https://vida.io/docs/api-reference/accounts/delete-member.md): Delete a member from your organization
- [Fetch Account by externalAccountId](https://vida.io/docs/api-reference/accounts/fetch-account-by-externalaccountid.md): Returns the account that matches the externalAccountId – Reseller/Partner only.
- [Fetch member](https://vida.io/docs/api-reference/accounts/fetch-member.md): Fetch details for a single member of your organization
- [Get account details](https://vida.io/docs/api-reference/accounts/get-account-details.md): Retrieve details for the authenticated account
- [Invite member](https://vida.io/docs/api-reference/accounts/invite-member.md): Invite a user to join your account as a member
- [List agent accounts](https://vida.io/docs/api-reference/accounts/list-agent-accounts.md): List all of your agent accounts
- [List members](https://vida.io/docs/api-reference/accounts/list-members.md): List all members of your organization
- [List organizations](https://vida.io/docs/api-reference/accounts/list-organizations.md): List all of your organizations. Reseller account required.
- [List resellers](https://vida.io/docs/api-reference/accounts/list-resellers.md): List all of your resellers. Partner account required.
- [Search accounts](https://vida.io/docs/api-reference/accounts/search-accounts.md): Search partner, reseller, organization or account objects using various filters
- [Update account details](https://vida.io/docs/api-reference/accounts/update-account-details.md): Update profile details for the authenticated account
- [Update Account Settings](https://vida.io/docs/api-reference/accounts/update-account-settings.md): Update certain settings for an account – Reseller/Partner only.
- [Update member](https://vida.io/docs/api-reference/accounts/update-member.md): Update member details for your organization
- [Update Organization Settings](https://vida.io/docs/api-reference/accounts/update-organization-settings.md): Update certain settings for an organization – Reseller/Partner only.
- [Check agent url availability](https://vida.io/docs/api-reference/agent-urls/check-agent-url-availability.md): Check if an agent url is available for use
- [Create agent url](https://vida.io/docs/api-reference/agent-urls/create-agent-url.md): Create a new url for an agent and replace existing one if exists
- [Fetch existing agent url](https://vida.io/docs/api-reference/agent-urls/fetch-existing-agent-url.md): Check if existing agent url exists for a user or create new one
- [Create Named Version](https://vida.io/docs/api-reference/agents/create-named-version.md): Snapshot the current staging or default agent and store it under a custom title.
- [Fetch Live Agent](https://vida.io/docs/api-reference/agents/fetch-live-agent.md): Fetch your Live (default) agent configuration.
- [Fetch Staging Agent](https://vida.io/docs/api-reference/agents/fetch-staging-agent.md): Fetch your Staging agent configuration.
- [Get Agent](https://vida.io/docs/api-reference/agents/get-agent.md): Fetch an agent details
- [Get LLM feedback for agent configuration or specific fields](https://vida.io/docs/api-reference/agents/get-llm-feedback-for-agent-configuration-or-specific-fields.md): Runs the autoReviewAgentConfiguration engine in one of two modes: "fields" for field-level feedback using promptTips, or "agent" for a holistic review of the agent (main prompt, functions, apps, and greeting).
- [List Agent Versions](https://vida.io/docs/api-reference/agents/list-agent-versions.md): Return the stored version snapshots for an agent. Pass ?includeData=true to embed full snapshots.
- [Publish an Agent](https://vida.io/docs/api-reference/agents/publish-an-agent.md): Publish your staging agent to your active default agent.
- [Queue outbound call(s) from your Agent](https://vida.io/docs/api-reference/agents/queue-outbound-calls-from-your-agent.md): Backwards compatible with the previous endpoint. You can pass a single "target" and optional "context" (old behavior), or provide "targets" to enqueue multiple calls. This endpoint queues tasks instead of dialing immediately.
- [Queue outbound SMS text message(s) from your Agent](https://vida.io/docs/api-reference/agents/queue-outbound-sms-text-messages-from-your-agent.md): Backwards compatible with the previous endpoint. You can pass a single "target" and required "content", or provide "targets" to enqueue multiple messages. This queues tasks instead of sending immediately.
- [Rename Stored Version](https://vida.io/docs/api-reference/agents/rename-stored-version.md): Overwrite only the human-readable title of a stored snapshot.
- [Replace Stored Version](https://vida.io/docs/api-reference/agents/replace-stored-version.md): Overwrite an existing version snapshot by its numeric versionId.
- [Restore Version to Agent](https://vida.io/docs/api-reference/agents/restore-version-to-agent.md): Copy a stored snapshot into the staging (default) slot.
- [Revert an Agent](https://vida.io/docs/api-reference/agents/revert-an-agent.md): Revert staging agent to current default active agent settings
- [Update Agent](https://vida.io/docs/api-reference/agents/update-agent.md): Update an agent
- [Authentication](https://vida.io/docs/api-reference/authentication.md): Access all the data on Vida through our RESTful API.
- [Create a token](https://vida.io/docs/api-reference/authorization/create-a-token.md): Create a new token for your account
- [Delete a token](https://vida.io/docs/api-reference/authorization/delete-a-token.md): Delete a token from your account
- [Generate one-time auth token](https://vida.io/docs/api-reference/authorization/generate-one-time-auth-token.md): Generate a single-use authentication token for the specified account – Reseller/Partner account required. If the email does not exist and an externalAccountId is provided, the system will automatically add that email as a member of the organization.
- [List tokens](https://vida.io/docs/api-reference/authorization/list-tokens.md): List all your existing tokens.
- [Cancel product subscription](https://vida.io/docs/api-reference/billing/cancel-product-subscription.md): Cancel the current product subscription for the authenticated account
- [Configure ADR Export Settings](https://vida.io/docs/api-reference/billing/configure-adr-export-settings.md): Configure or update your ADR export settings
- [Fetch a product plan details](https://vida.io/docs/api-reference/billing/fetch-a-product-plan-details.md): Fetch a product plan details from your catalog
- [Provision Billing System Configuration](https://vida.io/docs/api-reference/billing/provision-billing-system-configuration.md): Provision or Update Your Billing System Configuration
- [Start a new billing period for an organization](https://vida.io/docs/api-reference/billing/start-a-new-billing-period-for-an-organization.md): Start a new billing period for an organization. This must be set on the day the current billing period ends – Reseller/Partner only.
- [Subscribe to product plan](https://vida.io/docs/api-reference/billing/subscribe-to-product-plan.md): Subscribe to a product plan
- [View Available Add Ons](https://vida.io/docs/api-reference/billing/view-available-add-ons.md): View all available Add-Ons for current product plan
- [View Available Product Plans](https://vida.io/docs/api-reference/billing/view-available-product-plans.md): View All Available Product Plans
- [View Current Product Plan](https://vida.io/docs/api-reference/billing/view-current-product-plan.md): View Your Current Product Plan
- [View Offered Product Plan](https://vida.io/docs/api-reference/billing/view-offered-product-plan.md): View Your Product Plan Offer
- [View Product Catalog](https://vida.io/docs/api-reference/billing/view-product-catalog.md): View Your Product Catalog Plans. Reseller or Partner Account Required.
- [View Usage](https://vida.io/docs/api-reference/billing/view-usage.md): View statistics about account usage
- [Getting Started](https://vida.io/docs/api-reference/getting-started.md): Get started with Vida's AI enabled communications platform.
- [Update integration data](https://vida.io/docs/api-reference/integrations/update-integration-data.md): Update existing integration data for a specific integration slug and version
- [Update integration data](https://vida.io/docs/api-reference/integrations/update-integration-data-1.md): Update existing integration data for a specific integration slug and version
- [Add Context](https://vida.io/docs/api-reference/knowledge/add-context.md): Injects additional information context your agent can use in conversations with a specific person.
- [Fetch Context](https://vida.io/docs/api-reference/knowledge/fetch-context.md): Fetch additional information context stored for conversations with a particular person.
- [Query conversation logs](https://vida.io/docs/api-reference/logs/query-conversation-logs.md): Query conversation logs with flexible filters and optional CSV export
- [Fetch multiple conversations](https://vida.io/docs/api-reference/messaging/fetch-multiple-conversations.md): Fetch multiple conversation transcripts in one request using roomId + uuid pairs. Intended for logs -> conversation workflows where each item comes from /api/v2/logs.
- [Fetch Recent Messages](https://vida.io/docs/api-reference/messaging/fetch-recent-messages.md): Fetch recent messages across all inboxes.
- [Fetch Room Messages](https://vida.io/docs/api-reference/messaging/fetch-room-messages.md): Fetch all messages for a particular room Id
- [List Junk Inbox](https://vida.io/docs/api-reference/messaging/list-junk-inbox.md): Fetch rooms in junk inbox
- [List Priority Inbox](https://vida.io/docs/api-reference/messaging/list-priority-inbox.md): Fetch rooms in priority inbox
- [Send message to an agent from your own platform](https://vida.io/docs/api-reference/messaging/send-message-to-an-agent-from-your-own-platform.md): Send a message from your platform to an agent. Must pass outboundMessageWebhookUrl or configure on the organization to receive agent responses. Reseller or partners only.
- [List supported AI models](https://vida.io/docs/api-reference/models/list-supported-ai-models.md): Returns the supported AI model identifiers along with their provider metadata.
- [API Overview](https://vida.io/docs/api-reference/overview.md): Get started with Vida's AI enabled communications platform.
- [Add a numbering provider to an organization](https://vida.io/docs/api-reference/phone-numbers/add-a-numbering-provider-to-an-organization.md): Create a new numbering provider configuration for an organization – Reseller/Partner only.
- [Assign a BYO phone number](https://vida.io/docs/api-reference/phone-numbers/assign-a-byo-phone-number.md): Assign a phone number you are supplying yourself to an agent. Requires reseller account.
- [Assign phone number to your account](https://vida.io/docs/api-reference/phone-numbers/assign-phone-number-to-your-account.md): Assign phone number to your account for use
- [List supported numbering providers](https://vida.io/docs/api-reference/phone-numbers/list-supported-numbering-providers.md): Returns every numbering provider supported along with configuration requirements. Requires a valid reseller or partner account.
- [Return / Unassign Phone Number](https://vida.io/docs/api-reference/phone-numbers/return-unassign-phone-number.md): Return a phone number and unassigns the number from the agent account. If provided by an external integrated number supplier, will return to them too. Requires reseller account.
- [Search for local numbers by locality](https://vida.io/docs/api-reference/phone-numbers/search-for-local-numbers-by-locality.md): Search for a phone number based on city, region, and country.
- [Search for local numbers by phrase](https://vida.io/docs/api-reference/phone-numbers/search-for-local-numbers-by-phrase.md): Search for a phone number based on phrase.
- [Search for local numbers by prefix](https://vida.io/docs/api-reference/phone-numbers/search-for-local-numbers-by-prefix.md): Search for a phone number based on prefix.
- [Update an existing numbering provider](https://vida.io/docs/api-reference/phone-numbers/update-an-existing-numbering-provider.md): Modify an existing numbering provider configuration, set default, or disable it – Reseller/Partner only.
- [Add IP to SIP IP Whitelist](https://vida.io/docs/api-reference/sip/add-ip-to-sip-ip-whitelist.md): Add a new IP address to your SIP IP whitelist.
- [Add SIP Outbound Route](https://vida.io/docs/api-reference/sip/add-sip-outbound-route.md): Add a new outbound route for SIP. IP or domain Required (port and transport optional).
- [Check SIP registration AOR availability](https://vida.io/docs/api-reference/sip/check-sip-registration-aor-availability.md): Validate whether an Address of Record (AOR) is free for the authenticated account.
- [Create or update SIP registration](https://vida.io/docs/api-reference/sip/create-or-update-sip-registration.md): Create a new SIP registration or update the existing registration for the authenticated account.
- [Delete SIP registration](https://vida.io/docs/api-reference/sip/delete-sip-registration.md): Remove the SIP registration for the authenticated account.
- [Fetch sip captures by sip call id](https://vida.io/docs/api-reference/sip/fetch-sip-captures-by-sip-call-id.md)
- [Get SIP registration](https://vida.io/docs/api-reference/sip/get-sip-registration.md): Retrieve the SIP registration associated with the authenticated account.
- [List SIP IP Whitelist](https://vida.io/docs/api-reference/sip/list-sip-ip-whitelist.md): List all your existing SIP IP whitelist entries.
- [List SIP Outbound Routes](https://vida.io/docs/api-reference/sip/list-sip-outbound-routes.md): List all existing SIP outbound routes for a user.
- [Remove IP from SIP IP Whitelist](https://vida.io/docs/api-reference/sip/remove-ip-from-sip-ip-whitelist.md): Remove an existing IP address from your SIP IP whitelist.
- [Remove SIP Outbound Route](https://vida.io/docs/api-reference/sip/remove-sip-outbound-route.md): Remove an existing SIP outbound route.
- [Create a new task](https://vida.io/docs/api-reference/tasks/create-a-new-task.md): Submit a new task (call, text). For calls/texts, target is required.
- [Create multiple tasks via CSV upload](https://vida.io/docs/api-reference/tasks/create-multiple-tasks-via-csv-upload.md): Upload a CSV file to create multiple tasks. The CSV must include a header row. Recognized columns include type, target, context, taskContext, greeting, waitToGreet, accountId, scheduledFor, message, and externalTaskId.
- [Daily counts](https://vida.io/docs/api-reference/tasks/daily-counts.md): Get current daily usage counts (calls, texts, tasks) for rate limiting.
- [Delete a task](https://vida.io/docs/api-reference/tasks/delete-a-task.md): Remove a task by ID.
- [Fetch a specific task](https://vida.io/docs/api-reference/tasks/fetch-a-specific-task.md): Retrieve details for a single task by ID.
- [Fetch all tasks](https://vida.io/docs/api-reference/tasks/fetch-all-tasks.md): Retrieve all tasks for the current org. Supports filtering, sorting, and pagination.
- [Fetch task limits](https://vida.io/docs/api-reference/tasks/fetch-task-limits.md): Retrieve the org’s current task limits configuration.
- [Task statistics](https://vida.io/docs/api-reference/tasks/task-statistics.md): Get counts of tasks grouped by state (pending, running, finished, errored).
- [Update a task](https://vida.io/docs/api-reference/tasks/update-a-task.md): Update fields on an existing task by ID.
- [Update task limits](https://vida.io/docs/api-reference/tasks/update-task-limits.md): Update task limit settings. Non-superAdmins cannot edit daily or concurrencyPerRun.
- [Add Webhook](https://vida.io/docs/api-reference/webhooks/add-webhook.md): Add a new webhook destination.
- [Create or update a webhook relay](https://vida.io/docs/api-reference/webhooks/create-or-update-a-webhook-relay.md): Forward incoming webhooks of the specified type to your URL.
- [Delete a webhook relay configuration](https://vida.io/docs/api-reference/webhooks/delete-a-webhook-relay-configuration.md): Removes the stored webhook relay settings for the specified type from the authenticated user account.
- [Get a webhook relay configuration](https://vida.io/docs/api-reference/webhooks/get-a-webhook-relay-configuration.md): Fetch the current webhook relay settings for the given type (e.g., Twilio SMS, Chargebee) for your account.
- [List all webhook relay configurations](https://vida.io/docs/api-reference/webhooks/list-all-webhook-relay-configurations.md): Fetch the complete set of webhook relay settings configured on your account.
- [List supported Webhook Relay types](https://vida.io/docs/api-reference/webhooks/list-supported-webhook-relay-types.md): Returns every webhook relay type that can be configured for your account (e.g., Twilio SMS, Chargebee, etc.).
- [List Webhooks](https://vida.io/docs/api-reference/webhooks/list-webhooks.md): List all your existing webhook destinations.
- [Remove Webhook](https://vida.io/docs/api-reference/webhooks/remove-webhook.md): Remove an existing webhook destination.
- [Chargebee Billing Integration](https://vida.io/docs/billing/chargebee.md): Chargebee Billing Integration and Configuration
- [Stripe Billing Integration](https://vida.io/docs/billing/stripe.md): Stripe Billing Integration and Configuration
- [API Overview for Resellers and White-Label Users](https://vida.io/docs/enablement/api.md): Explore APIs tailored for resellers and white-label users to enable seamless integration and management of Vida's AI agent platform.
- [AI Agent Enablement Billing Tools](https://vida.io/docs/enablement/billing.md): Manage billing seamlessly for your AI Agent Enablement services with custom onboarding flows, branded subscriptions, and APIs.
- [Agent Detail Record Exports](https://vida.io/docs/enablement/billing_exports.md): Exporting your Agent Detail Records (ADRs) to an external billing/rating engine
- [Embedding Tools for AI Enablement](https://vida.io/docs/enablement/embed.md): Guide for white-label resellers to embed AI agents into their clients' websites and customize the experience.
- [Embedding the VIDA App via Iframe](https://vida.io/docs/enablement/embed_app.md): Guide for resellers to integrate the VIDA application into their websites using an iframe.
- [Product Items](https://vida.io/docs/enablement/product_items.md): Overview of the Product Items supported on the Vida AI Enablement platform
- [General SIP Guide for AI Enablement](https://vida.io/docs/enablement/sip.md): Learn how to configure SIP for both inbound and outbound calls with Vida AI phone agents.
- [Vida Telemetry Script Guide for Pendo](https://vida.io/docs/enablement/telemetry.md): How to inject Pendo telemetry into the Vida iframe, identify users and accounts, and track pages and events.
- [Usage Features for AI Agent Enablement](https://vida.io/docs/enablement/usage.md): Track and manage detailed usage data across all tiers of your AI agent enablement platform, with maximum flexibility for resellers and their customers.
- [White-Label Capabilities](https://vida.io/docs/enablement/whitelabel.md): Discover the extensive white-label options available to tailor Vida’s AI platform to your brand and offer a seamless experience for your customers.
- [Home Services](https://vida.io/docs/examples/home-services.md): Example of Vida agent configured to answer calls for a home services company.
- [Logistics](https://vida.io/docs/examples/logistics.md): Example of Vida agent configured to handle calls for a logistics company.
- [Professional Services](https://vida.io/docs/examples/professional-services.md): Example of Vida agent configured to book consultations for an IT services company.
- [Restaurant](https://vida.io/docs/examples/restaurants.md): Example of Vida agent configured to answer calls for a restaurant.
- [Retail](https://vida.io/docs/examples/retail.md): Example of Vida agent configured to answer calls for a retail store.
- [Salon](https://vida.io/docs/examples/salon.md): Example of Vida agent configured to handle calls for a salon.
- [Call Transfer](https://vida.io/docs/functions/call-transfer.md): How to configure and use Call Transfer actions in Vida agents.
- [Notify](https://vida.io/docs/functions/notify.md): How to configure and use the Notify function in Vida agents.
- [Request Payment](https://vida.io/docs/functions/payments.md): How to enable your Vida agent to request payment before it performs an action.
- [Post-Convo](https://vida.io/docs/functions/post-convo.md): How to configure and use the Post (after) Convo function in Vida agents.
- [Pre-Answer](https://vida.io/docs/functions/pre-answer.md): How to configure and use the Pre-Answer function in Vida agents.
- [Reporting](https://vida.io/docs/functions/reporting.md): How to configure and use the Reporting function in Vida agents.
- [Schedule](https://vida.io/docs/functions/schedule.md): How to configure and use Schedule function in Vida agents.
- [Send Email](https://vida.io/docs/functions/send-email.md): How to configure and use the Send Email function in Vida agents.
- [Send SMS](https://vida.io/docs/functions/send-sms.md): How to configure and use the Send SMS function in Vida agents.
- [Audio Recording](https://vida.io/docs/functions/start-stop-recording.md): How to configure and use Record Audio function.
- [Take a Message](https://vida.io/docs/functions/take-message.md): How to configure and use Take a Message functions in Vida agents.
- [Validate Address](https://vida.io/docs/functions/validate-address.md): How to configure and use the Validate Address function in Vida agents.
- [Webhooks](https://vida.io/docs/functions/webhooks.md): How to configure and use Webhook actions in Vida agents.
- [Zapier](https://vida.io/docs/functions/zapier.md): How to configure and use the Zapier agent function in Vida AI phone agents.
- [Athena Health](https://vida.io/docs/integrations/athena.md): Vida AI phone agents integrate with Athena Health for appointment scheduling and more!
- [Cox Automotive](https://vida.io/docs/integrations/coxauto.md): Vida AI phone agents integrate with Cox Automotive APIs for scheduling, lead qualification, and more!
- [Google Calendar](https://vida.io/docs/integrations/google-calendar.md): Vida AI phone agents integrate with Google Calendar to streamline scheduling and conflict checking!
- [Integrate your Agent](https://vida.io/docs/integrations/intro.md): Vida AI phone agents integrate with thousands of apps including CRMs, Ticketing systems, and more!
- [Zapier](https://vida.io/docs/integrations/zapier.md): Use Vida AI phone agents with Zapier to integrate with thousands of apps!
- [OpenAI Speech-to-Speech](https://vida.io/docs/realtime.md): Integrating OpenAI's Realtime Speech-to-Speech API with Vida Agents
- [Embed your Agent](https://vida.io/docs/sharing/embed.md): Embed your Vida AI agent into your website to allow visitors to talk to your agent from anywhere.
- [Forward Calls to your Agent](https://vida.io/docs/sharing/forward.md): How to forward calls to your Vida AI phone agent.
- [Port an Existing Number](https://vida.io/docs/sharing/port-number.md): How to port your existing number
- [Share Agent profile](https://vida.io/docs/sharing/profile.md): Every Vida AI phone agent has a public profile. Share the link to share your agent!
- [Publish your Agent](https://vida.io/docs/sharing/publish.md): How to share your Vida Agent by publishing its number and sharing its profile.
- [SIP to your Agent](https://vida.io/docs/sip/sip-inbound.md): Vida AI phone agents can receive inbound calls over SIP / VoIP.
- [SIP from your agent](https://vida.io/docs/sip/sip-outbound.md): Vida AI phone agents can send outbound calls over SIP / VoIP.
- [SIP Registration](https://vida.io/docs/sip/sip-registration.md): SIP Register your Vida AI agent to an external PBX to send and receive calls.
- [Documentation](https://vida.io/docs/welcome.md): Docs, tutorials, guides, and more, for Vida, the leading AI phone agent for small business. Answer calls and texts with an AI phone agent that always works and is never busy.

## OpenAPI Specs

- [apiv2](https://vida.io/docs/apiv2.json)
- [openapi](https://vida.io/docs/api-reference/openapi.json)