# Vida AI Agent OS Docs

## Docs

- [Documentation](https://vida.io/docs/welcome.md): Build, deploy, operate, and integrate Vida AI Agents for business communications and operations.
- [Set up a Vida Agent](https://vida.io/docs/agents/intro.md): Configure an Agent for communications, connected actions, and business workflows.
- [Edit and publish your Agent](https://vida.io/docs/agents/configuration.md): Update, test, save, and publish your Agent from the Vida editor.
- [Instructions](https://vida.io/docs/agents/instructions.md): Define your Agent's role, goals, boundaries, and behavior.
- [Intelligence and reasoning](https://vida.io/docs/agents/intelligence.md): Choose how your Vida Agent thinks, responds, and handles difficult decisions.
- [Functions](https://vida.io/docs/agents/functions.md): Give your Vida Agent useful actions such as scheduling, transfers, messages, and Computer work.
- [Agent apps](https://vida.io/docs/agents/apps.md): Connect external services and make them available to your Vida Agent.
- [Links](https://vida.io/docs/agents/links.md): Give your AI Agent access to external information on the web.
- [Voice and speech mode](https://vida.io/docs/agents/voice.md): Choose a voice that fits your brand, language, and calling experience.
- [Speech-to-speech](https://vida.io/docs/realtime.md): Understand when to use speech-to-speech mode for a voice Agent.
- [Greeting](https://vida.io/docs/agents/greeting.md): Tips on configuring how your Agent answers the phone or starts web conversations.
- [Language](https://vida.io/docs/agents/language.md): Choose the language or multilingual behavior your Vida Agent should use.
- [Contacts](https://vida.io/docs/agents/contacts.md): Give Vida Agents consistent customer identity and communication context.
- [Email](https://vida.io/docs/agents/email.md): Give an Agent an email address, control who can contact it, and verify email workflows.
- [Enabling SMS](https://vida.io/docs/agents/enable-sms.md): Enable SMS capabilities on your Vida Agent by registering your Brand and Texting Campaign with Carriers.
- [What is a Computer Agent?](https://vida.io/docs/computer-agents/overview.md): Understand how Computer Agents differ from conversational Agents and how they work together.
- [Set up a Computer Agent](https://vida.io/docs/computer-agents/getting-started.md): Create, configure, provision, and test a Computer Agent in Vida.
- [Computer Agent capabilities](https://vida.io/docs/computer-agents/capabilities.md): Give a Computer Agent the skills, access, browser workflows, files, and channels it needs.
- [Build an Agent Canvas](https://vida.io/docs/computer-agents/canvas.md): Create and publish a simple web experience that your Computer Agent can maintain.
- [Skills, accounts, and credentials](https://vida.io/docs/computer-agents/skills-and-access.md): Connect a Computer Agent to the services and information required for its work.
- [Manage Computer Agent Credentials Safely](https://vida.io/docs/computer-agents/managed-credentials.md): Connect skills, channels, browser sessions, and reusable helpers without putting credentials in prompts or files.
- [Reusable helpers and browser automation](https://vida.io/docs/computer-agents/reusable-helpers.md): Turn a stable software operation into a tested function a Vida Agent can call.
- [Connect a Computer Agent channel](https://vida.io/docs/computer-agents/channels.md): Let approved people work with a Computer Agent through Slack or another supported channel.
- [Assign work and automate it](https://vida.io/docs/computer-agents/tasks-and-automation.md): Choose between chat, Computer Tasks, repeating work, heartbeats, and delegation.
- [Design Useful Computer Agent Heartbeats](https://vida.io/docs/computer-agents/heartbeats.md): Give a Computer Agent periodic awareness without creating noisy, repetitive, or unactionable alerts.
- [Monitor and support a Computer Agent](https://vida.io/docs/computer-agents/monitoring-and-safety.md): Keep Computer Agents reliable, useful, recoverable, and appropriately supervised.
- [Launch an Agent: Production Checklist](https://vida.io/docs/operations/launch-checklist.md): Take a Vida Agent from a defined business outcome through testing, publishing, channel activation, and a controlled production rollout.
- [Tasks and Outbound Automation](https://vida.io/docs/operations/tasks-and-outbound.md): Schedule calls, texts, emails, Computer work, and repeating automation while keeping outcomes and retries visible.
- [Troubleshoot with Logs and Conversations](https://vida.io/docs/operations/logs-and-conversations.md): Use Vida logs, Task history, and complete conversations to understand what an Agent did and why.
- [Measure and Improve Your Agent](https://vida.io/docs/operations/measurement-and-experiments.md): Turn conversations into reliable reporting fields, dashboard metrics, saved versions, and controlled Agent experiments.
- [Inbox, Escalation, and Human Handoff](https://vida.io/docs/operations/inbox-and-handoff.md): Review Agent conversations, prioritize follow-up, and design handoffs that give people enough context to help.
- [Phone Numbers and Channel Routing](https://vida.io/docs/operations/phone-numbers-and-routing.md): Choose and verify the phone, SMS, SIP, web, and forwarding routes that connect customers to a Vida Agent.
- [Members, Roles, and Account Access](https://vida.io/docs/operations/members-and-access.md): Give teammates the Vida access they need while keeping customer and Agent visibility appropriately scoped.
- [Webhooks](https://vida.io/docs/functions/webhooks.md): How to configure and use Webhook actions in Vida agents.
- [Call Transfer](https://vida.io/docs/functions/call-transfer.md): How to configure and use Call Transfer actions in Vida agents.
- [Take a Message](https://vida.io/docs/functions/take-message.md): How to configure and use Take a Message functions in Vida agents.
- [Notify](https://vida.io/docs/functions/notify.md): How to configure and use the Notify function 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.
- [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.
- [Schedule](https://vida.io/docs/functions/schedule.md): How to configure and use Schedule 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.
- [Pre-Answer](https://vida.io/docs/functions/pre-answer.md): How to configure and use the Pre-Answer function in Vida agents.
- [Pre Transfer](https://vida.io/docs/functions/pre-transfer.md): Complete required work immediately before transferring a call.
- [Post Transfer](https://vida.io/docs/functions/post-transfer.md): Complete follow-up work after a call transfer connects.
- [Post-Convo](https://vida.io/docs/functions/post-convo.md): How to configure and use the Post (after) Convo function in Vida agents.
- [Play Audio](https://vida.io/docs/functions/play-audio.md): Play an approved recording at the right moment during a voice call.
- [Pause & Think](https://vida.io/docs/functions/pause-think.md): Give your Agent a private reasoning step before it replies.
- [Browser](https://vida.io/docs/functions/browser.md): Let your Agent perform ad hoc work in its live Browser.
- [Computer](https://vida.io/docs/functions/computer.md): Delegate a bounded multi-step task to a Vida Computer Agent.
- [Reporting](https://vida.io/docs/functions/reporting.md): Define structured outcomes for Vida Agents to report after conversations.
- [Zapier](https://vida.io/docs/functions/zapier.md): How to configure and use the Zapier agent function in Vida Agents.
- [Audio Recording](https://vida.io/docs/functions/start-stop-recording.md): How to configure and use Record Audio function.
- [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.
- [Home Services](https://vida.io/docs/examples/home-services.md): Example of Vida agent configured to answer calls for a home services company.
- [Professional Services](https://vida.io/docs/examples/professional-services.md): Example of Vida agent configured to book consultations for an IT services company.
- [Salon](https://vida.io/docs/examples/salon.md): Example of Vida agent configured to handle calls for a salon.
- [Logistics](https://vida.io/docs/examples/logistics.md): Example of Vida agent configured to handle calls for a logistics company.
- [Launch and Manage Reseller Customers](https://vida.io/docs/enablement/reseller-customer-onboarding.md): Build a repeatable reseller onboarding flow across organizations, Agents, plans, branding, billing, access, and support.
- [Reseller Agent Templates](https://vida.io/docs/enablement/reseller-agent-templates.md): Create a tested Agent starting point that eligible resellers can apply consistently during customer onboarding.
- [Reseller Billing and Payouts](https://vida.io/docs/enablement/reseller-billing-and-payouts.md): Package Vida Agents into customer plans, manage recurring revenue, and support reseller payout workflows from one platform.
- [Reseller Customer Billing](https://vida.io/docs/enablement/billing.md): Connect customer plans in Vida with Stripe or Chargebee subscriptions, renewals, access, and supported usage charges.
- [Stripe Billing Integration](https://vida.io/docs/billing/stripe.md): Stripe Billing Integration and Configuration
- [Chargebee Billing Integration](https://vida.io/docs/billing/chargebee.md): Chargebee Billing Integration and Configuration
- [Usage, Plans, and Customer Consumption](https://vida.io/docs/enablement/usage.md): Understand Vida product usage across Agents, organizations, resellers, and optional partner accounts.
- [Product Items and Plan Usage](https://vida.io/docs/enablement/product_items.md): Use Vida product items to define what a customer plan includes and how consumption is measured.
- [White-label Vida](https://vida.io/docs/enablement/whitelabel.md): Present Vida under your brand with eligible reseller domains, application settings, communications, and embedded access.
- [Choose How to Embed Vida](https://vida.io/docs/enablement/embed.md): Embed one Agent interaction on a website or place the complete Vida customer application inside your product.
- [Embed the Vida app](https://vida.io/docs/enablement/embed_app.md): Authenticate a reseller customer from your backend and open the Vida application in an iframe.
- [API enablement for resellers](https://vida.io/docs/enablement/api.md): Use Vida APIs to provision, configure, operate, and measure customer Agent deployments.
- [SIP Overview](https://vida.io/docs/enablement/sip.md): Choose the SIP registration, inbound access, and outbound routing capabilities needed to connect Vida with your telephony system.
- [Agent Detail Record Exports](https://vida.io/docs/enablement/billing_exports.md): Exporting your Agent Detail Records (ADRs) to an external billing/rating engine
- [Reseller Application Telemetry](https://vida.io/docs/enablement/telemetry.md): Connect an eligible reseller or partner Vida application to an analytics provider using lifecycle scripts.
- [Request an Additional Agent Voice](https://vida.io/docs/enablement/voices.md): Ask Vida to make an additional supported text-to-speech voice available to your account.
- [SIP Registration](https://vida.io/docs/sip/sip-registration.md): Register a Vida Agent to an external PBX or SIP service for supported inbound, outbound, and transfer workflows.
- [SIP to Your Agent](https://vida.io/docs/sip/sip-inbound.md): Allow approved telephony systems to send inbound SIP calls to a Vida Agent.
- [SIP from Your Agent](https://vida.io/docs/sip/sip-outbound.md): Route approved outbound Vida calls to a SIP domain, IP, or proxy.
- [Forward Calls to your Agent](https://vida.io/docs/sharing/forward.md): How to forward calls to your Vida Agent.
- [Publish and share your Agent](https://vida.io/docs/sharing/publish.md): Make a tested Agent configuration live, then connect the channels customers will use.
- [Share an Agent profile](https://vida.io/docs/sharing/profile.md): Give customers a web link where they can talk or chat with a published Agent.
- [Embed Your Agent](https://vida.io/docs/sharing/embed.md): Add a call or chat button for one published Vida Agent to a website.
- [Port an Existing Number](https://vida.io/docs/sharing/port-number.md): How to port your existing number
- [Choose the Right Integration Approach](https://vida.io/docs/integrations/choose-an-approach.md): Decide whether a Vida workflow should use an app, function, webhook, Zapier, reusable helper, Computer Agent, or Canvas.
- [Integrate your Agent](https://vida.io/docs/integrations/intro.md): Connect Vida Agents to calendars, CRMs, business systems, and custom workflows.
- [Zapier](https://vida.io/docs/integrations/zapier.md): Connect Vida Agents to thousands of applications through Zapier.
- [athenahealth](https://vida.io/docs/integrations/athena.md): Use athenahealth in supported patient scheduling workflows.
- [Cox Automotive](https://vida.io/docs/integrations/coxauto.md): Use supported Cox Automotive systems in dealership service and lead workflows.
- [Google Calendar](https://vida.io/docs/integrations/google-calendar.md): Vida Agents integrate with Google Calendar to streamline scheduling and conflict checking!
- [Vida API overview](https://vida.io/docs/api-reference/overview.md): Build, configure, operate, and measure Vida AI Agents programmatically.
- [Getting started](https://vida.io/docs/api-reference/getting-started.md): Authenticate, select the correct Vida account, and make a verified API request.
- [Authentication](https://vida.io/docs/api-reference/authentication.md): Create a Vida API token and use it with the correct authorized account scope.
- [Vida API Skill](https://vida.io/docs/api-reference/vida-api-skill.md): Give an external AI agent the operational guidance needed to use the Vida API safely.
- [Configure Agents through the API](https://vida.io/docs/api-reference/agent-guides/overview.md): Understand Agent accounts, configurations, discovery, staging, and publishing.
- [Configuration lifecycle](https://vida.io/docs/api-reference/agent-guides/configuration-lifecycle.md): Safely read, update, version, test, and publish an Agent configuration.
- [Versions and experiments](https://vida.io/docs/api-reference/agent-guides/versions-and-experiments.md): Save Agent configurations, restore them safely, and compare variants with controlled experiments.
- [Models and reasoning](https://vida.io/docs/api-reference/agent-guides/models-and-reasoning.md): Discover account-supported models and configure Agent reasoning behavior.
- [Language, voice, and speech](https://vida.io/docs/api-reference/agent-guides/language-voice-and-speech.md): Configure compatible language, speech mode, recognition, and voice settings.
- [Agent functions](https://vida.io/docs/api-reference/agent-guides/functions.md): Discover, configure, verify, and publish Agent functions through the API.
- [Agent apps](https://vida.io/docs/api-reference/agent-guides/apps.md): Discover, install, configure, assign, and verify apps through the API.
- [Phone numbers and SIP](https://vida.io/docs/api-reference/agent-guides/telephony.md): Connect an Agent to managed, BYO, or SIP calling through the API.
- [Computer Agent configuration](https://vida.io/docs/api-reference/agent-guides/computer-agents.md): Combine durable Agent configuration with Computer Agent operational resources.
- [Computer Agent lifecycle and support](https://vida.io/docs/api-reference/agent-guides/computer-agent-operations.md): Provision, inspect, diagnose, back up, repair, and safely update a Computer Agent.
- [Computer Agent skills, credentials, and channels](https://vida.io/docs/api-reference/agent-guides/computer-agent-skills-and-channels.md): Install and verify skills, complete setup and authorization, manage credentials, and connect Agent-specific channels.
- [Workspaces, helpers, and browser automation](https://vida.io/docs/api-reference/agent-guides/computer-agent-workspaces-and-helpers.md): Manage Computer Agent files and create exact reusable Browser or Browser-independent functions.
- [Computer Agent Canvas](https://vida.io/docs/api-reference/agent-guides/computer-agent-canvas.md): Edit, publish, open, and verify a Computer Agent Canvas through the API.
- [Tasks and automation](https://vida.io/docs/api-reference/platform-guides/tasks-and-automation.md): Create communication, Computer, retry, repeating, and one-off Tasks with verifiable outcomes.
- [Contacts and ongoing objectives](https://vida.io/docs/api-reference/platform-guides/contacts-and-objectives.md): Maintain customer context and compact workflow state across communications and Tasks.
- [Logs, conversations, and reporting](https://vida.io/docs/api-reference/platform-guides/logs-conversations-and-reporting.md): Trace Agent work from summary logs to complete conversations and measurable outcomes.
- [Accounts, access, and customer onboarding](https://vida.io/docs/api-reference/platform-guides/accounts-access-and-onboarding.md): Use the account structure your Vida plan provides, then create and verify only the resources each customer needs.
- [Connect Stripe or Chargebee billing](https://vida.io/docs/api-reference/platform-guides/billing-providers.md): Configure the billing provider an eligible reseller or partner uses to bill downstream customers.
- [Reseller Agent templates](https://vida.io/docs/api-reference/platform-guides/agent-templates.md): Create reusable Agent configuration drafts, apply them to customer Agents, and migrate revisions safely.
- [Integrations, inbound email, and webhooks](https://vida.io/docs/api-reference/platform-guides/integrations-email-and-webhooks.md): Connect external systems, control inbound email senders, and deliver Vida events reliably.
- [White-label domains and embedded access](https://vida.io/docs/api-reference/platform-guides/white-label-domains-and-embed.md): Manage reseller domains and open the Vida application inside a trusted customer experience.
- [List tokens](https://vida.io/docs/api-reference/authorization/list-tokens.md): List all your existing tokens.
- [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 agent functions](https://vida.io/docs/api-reference/agents/list-agent-functions.md): Lists the functions the selected account can add to an agent. Check allowed and missingRequirement before changing the staging configuration.
- [List agent voices](https://vida.io/docs/api-reference/agents/list-agent-voices.md): Lists the voices the selected account can configure. Use id as agentVoice, and check languages, compatibleS2SEngines, supportsStandardTts, and accountAvailability before saving.
- [Publish an Agent](https://vida.io/docs/api-reference/agents/publish-an-agent.md): Publish your staging agent to your active default agent.
- [Revert an Agent](https://vida.io/docs/api-reference/agents/revert-an-agent.md): Revert staging agent to current default active agent settings
- [Update staging agent configuration](https://vida.io/docs/api-reference/agents/update-staging-agent-configuration.md): Updates the selected account staging configuration. Omitted settings retain their current values. Publish separately when the staged changes are ready to become live.
- [List Agent Versions](https://vida.io/docs/api-reference/agents/list-agent-versions.md): Lists saved snapshots stored for the live configuration. Use the live agentConfigId returned by GET /api/v2/agentEventRules/default. Pass includeData=true to include each full snapshot.
- [Save agent version](https://vida.io/docs/api-reference/agents/save-agent-version.md): Saves the selected account current staging or live configuration as a named version. Versions are stored under the live agent configuration.
- [Replace saved agent version](https://vida.io/docs/api-reference/agents/replace-saved-agent-version.md): Replaces one saved version with a complete agent configuration snapshot. Read the existing snapshot first and preserve settings you do not intend to change.
- [Delete saved agent version](https://vida.io/docs/api-reference/agents/delete-saved-agent-version.md): Deletes a saved version. A version used by an active experiment or Task cannot be deleted.
- [Restore saved agent version](https://vida.io/docs/api-reference/agents/restore-saved-agent-version.md): Copies a saved version into staging by default. Use target=default only when an immediate live restore is intentional; staging restores still require publish.
- [Rename saved agent version](https://vida.io/docs/api-reference/agents/rename-saved-agent-version.md): Changes only the display title of a saved version.
- [Get Agent](https://vida.io/docs/api-reference/agents/get-agent.md): Returns one agent configuration by its agentConfigId. Use the staging or live endpoints when you want the selected account current slot without first knowing its identifier.
- [Queue outbound call(s) from your Agent](https://vida.io/docs/api-reference/agents/queue-outbound-calls-from-your-agent.md): Queue call Tasks for one target or up to 10,000 targets. The endpoint accepts Task goals, retry policies, organization defaults, external correlation IDs, metadata, and Contact List enrollment. Submissions over 1,000 targets require Idempotency-Key and return 202.
- [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): Queue SMS Tasks for one target and message or up to 10,000 targets. The endpoint accepts Task goals, retry policies, organization defaults, external correlation IDs, metadata, and Contact List enrollment. Submissions over 1,000 targets require Idempotency-Key and return 202.
- [Queue outbound email(s) from your Agent](https://vida.io/docs/api-reference/agents/queue-outbound-emails-from-your-agent.md): Queue email Tasks for an email-enabled agent account. Pass target or to/cc/bcc for one email, or use up to 10,000 targets for separate emails. Organization default goals and retries apply when configured; use POST /api/v2/tasks to supply a Task-specific goal or retry policy. Submissions over 1,000 t…
- [Fetch Staging Agent](https://vida.io/docs/api-reference/agents/fetch-staging-agent.md): Returns the editable staging configuration for the selected account. Changes made with POST /api/v2/agent remain in staging until published.
- [Fetch Live Agent](https://vida.io/docs/api-reference/agents/fetch-live-agent.md): Returns the live configuration currently used by the selected account. The live and staging configurations have different agentConfigId values.
- [Review an Agent configuration](https://vida.io/docs/api-reference/agents/review-an-agent-configuration.md): Reviews selected configuration fields or the complete Agent configuration and returns suggested improvements. This operation does not change or publish the Agent configuration.
- [List agent experiments](https://vida.io/docs/api-reference/agents/list-agent-experiments.md): Lists experiments for the selected organization. Supply agentConfigId to limit the results to one live agent configuration.
- [Create agent experiment](https://vida.io/docs/api-reference/agents/create-agent-experiment.md): Creates an experiment from at least two saved versions of the same live agent configuration. The weights are relative and do not need to total 100. Only one experiment for an agent configuration may be active at a time.
- [Get agent experiment](https://vida.io/docs/api-reference/agents/get-agent-experiment.md): Returns one experiment available to the selected organization.
- [Update agent experiment](https://vida.io/docs/api-reference/agents/update-agent-experiment.md): Renames an experiment and, while it is still a draft, can replace its saved-version variants. agentConfigId must match the experiment.
- [Delete agent experiment](https://vida.io/docs/api-reference/agents/delete-agent-experiment.md): Deletes a draft, paused, or ended experiment. Active experiments must be paused or ended first.
- [Change agent experiment status](https://vida.io/docs/api-reference/agents/change-agent-experiment-status.md): Starts, pauses, or ends an experiment. Starting an experiment routes new conversations deterministically across its saved-version variants according to their relative weights.
- [List assigned phone numbers](https://vida.io/docs/api-reference/phone-numbers/list-assigned-phone-numbers.md): Returns phone numbers assigned to the selected agent account and identifies its primary number.
- [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
- [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.
- [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 prefix](https://vida.io/docs/api-reference/phone-numbers/search-for-local-numbers-by-prefix.md): Search for a phone number based on prefix.
- [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.
- [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.
- [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 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.
- [Fetch SIP Captures by SIP Call-ID](https://vida.io/docs/api-reference/sip/fetch-sip-captures-by-sip-call-id.md): Search Vida SIP Captures by SIP Call-ID and export PCAP, JSON, or text transcript.
- [List SIP IP Whitelist](https://vida.io/docs/api-reference/sip/list-sip-ip-whitelist.md): List all your existing SIP IP whitelist entries.
- [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.
- [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.
- [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.
- [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).
- [Remove SIP Outbound Route](https://vida.io/docs/api-reference/sip/remove-sip-outbound-route.md): Remove an existing SIP outbound route.
- [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.
- [Get SIP registration](https://vida.io/docs/api-reference/sip/get-sip-registration.md): Retrieve the SIP registration associated with 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.
- [List Priority Inbox](https://vida.io/docs/api-reference/messaging/list-priority-inbox.md): Fetch rooms in priority inbox
- [List Junk Inbox](https://vida.io/docs/api-reference/messaging/list-junk-inbox.md): Fetch rooms in junk inbox
- [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
- [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 Webhooks](https://vida.io/docs/api-reference/webhooks/list-webhooks.md): List all your existing webhook destinations.
- [Add Webhook](https://vida.io/docs/api-reference/webhooks/add-webhook.md): Add a new webhook destination.
- [Remove Webhook](https://vida.io/docs/api-reference/webhooks/remove-webhook.md): Remove an existing webhook destination.
- [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.).
- [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.
- [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.
- [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.
- [Fetch Context](https://vida.io/docs/api-reference/knowledge/fetch-context.md): Fetch additional information context stored for conversations with a particular person.
- [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.
- [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
- [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 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
- [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.
- [List resellers](https://vida.io/docs/api-reference/accounts/list-resellers.md): List all of your resellers. Partner account required.
- [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).
- [Delete an organization](https://vida.io/docs/api-reference/accounts/delete-an-organization.md): Delete (immediately) an organization under your reseller. Reseller account required.
- [List organizations](https://vida.io/docs/api-reference/accounts/list-organizations.md): List all of your organizations. Reseller account required.
- [Get account details](https://vida.io/docs/api-reference/accounts/get-account-details.md): Retrieve details for the authenticated account
- [Update account details](https://vida.io/docs/api-reference/accounts/update-account-details.md): Update selected profile details or supported settings for an account.
- [List agent accounts](https://vida.io/docs/api-reference/accounts/list-agent-accounts.md): List all of your agent accounts
- [Create an agent account](https://vida.io/docs/api-reference/accounts/create-an-agent-account.md): Creates a child agent account under an organization. Use the returned account ID when configuring and provisioning a Computer Agent.
- [Delete an account](https://vida.io/docs/api-reference/accounts/delete-an-account.md): Delete an account under your organization
- [List members](https://vida.io/docs/api-reference/accounts/list-members.md): List all members of your organization
- [Fetch member](https://vida.io/docs/api-reference/accounts/fetch-member.md): Fetch details for a single member of your organization
- [Update member](https://vida.io/docs/api-reference/accounts/update-member.md): Update member details for your organization
- [Invite member](https://vida.io/docs/api-reference/accounts/invite-member.md): Invite a user to join your account as a member
- [Delete member](https://vida.io/docs/api-reference/accounts/delete-member.md): Delete a member from your organization
- [Search accounts](https://vida.io/docs/api-reference/accounts/search-accounts.md): Search partner, reseller, organization or account objects using various filters
- [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.
- [Update Organization Settings](https://vida.io/docs/api-reference/accounts/update-organization-settings.md): Update certain settings for an organization – Reseller/Partner only.
- [Update Account Settings](https://vida.io/docs/api-reference/accounts/update-account-settings.md): Update certain settings for an account – Reseller/Partner only.
- [Get reseller settings](https://vida.io/docs/api-reference/accounts/get-reseller-settings.md): Returns the selected reseller's identity, status, product-plan, and external-system identifiers. This operation requires an authorized partner account.
- [Update reseller settings](https://vida.io/docs/api-reference/accounts/update-reseller-settings.md): Updates selected reseller settings from an authorized partner account. Read the current settings first, send only intended changes, and verify updatedSettings and failedSettings in the response.
- [View Usage](https://vida.io/docs/api-reference/billing/view-usage.md): View statistics about account usage
- [View Offered Product Plan](https://vida.io/docs/api-reference/billing/view-offered-product-plan.md): View Your Product Plan Offer
- [View Current Product Plan](https://vida.io/docs/api-reference/billing/view-current-product-plan.md): View Your Current Product Plan
- [View Available Product Plans](https://vida.io/docs/api-reference/billing/view-available-product-plans.md): View All Available Product Plans
- [Get billing provider configuration](https://vida.io/docs/api-reference/billing/get-billing-provider-configuration.md): Returns the configured Stripe or Chargebee provider for the selected reseller or partner account. Credential values are redacted and are display-only; do not submit them in an update request.
- [Configure a billing provider](https://vida.io/docs/api-reference/billing/configure-a-billing-provider.md): Stores the complete Stripe or Chargebee configuration used to bill downstream customers for the selected reseller or partner account. Each request replaces the current provider configuration. Supply every required field with its original value; redacted values returned by GET cannot be reused.
- [Subscribe to product plan](https://vida.io/docs/api-reference/billing/subscribe-to-product-plan.md): Subscribe to a product plan
- [Cancel product subscription](https://vida.io/docs/api-reference/billing/cancel-product-subscription.md): Cancel the current product subscription for the authenticated account
- [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 Product Catalog](https://vida.io/docs/api-reference/billing/view-product-catalog.md): View Your Product Catalog Plans. Reseller or Partner Account Required.
- [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
- [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.
- [Configure ADR Export Settings](https://vida.io/docs/api-reference/billing/configure-adr-export-settings.md): Configure or update your ADR export settings
- [Fetch all tasks](https://vida.io/docs/api-reference/tasks/fetch-all-tasks.md): Retrieve Tasks for the current organization. Each retry cadence remains one Task; attemptHistory contains its individual attempts. Exact filters may be combined, and meta.<path> filters nested metadata values.
- [Create a new task](https://vida.io/docs/api-reference/tasks/create-a-new-task.md): Creates communication, scheduled, or Computer Agent work. Computer Tasks run only on provisioned Computer Agents and preserve their complete work in a linked conversation.
- [Create multiple tasks via CSV upload](https://vida.io/docs/api-reference/tasks/create-multiple-tasks-via-csv-upload.md): Upload up to 10,000 Tasks. Headers are case-insensitive. Recognized columns are type, target, context, taskContext, greeting, waitToGreet, accountId, scheduledFor, message, externalTaskId, goal.description, goal.completionCriteria, retryPolicy.delaysSeconds, retryPolicy.retryOn, and retryPolicy.resp…
- [Task statistics](https://vida.io/docs/api-reference/tasks/task-statistics.md): Get Task counts by state and conversion results for each attempt number.
- [Recent task batches](https://vida.io/docs/api-reference/tasks/recent-task-batches.md): List recent server-generated submission batches. Single-task batches are excluded unless includeSingles is true.
- [Create a task batch](https://vida.io/docs/api-reference/tasks/create-a-task-batch.md): Create up to 10,000 Tasks from either an explicit tasks array or a Contact List plus one Task template. Each Task uses the same fields and retry contract as POST /api/v2/tasks. Submissions over 1,000 Tasks require Idempotency-Key and return 202 while they are created.
- [Fetch task batch status](https://vida.io/docs/api-reference/tasks/fetch-task-batch-status.md): Fetch the creation status of an asynchronous Task submission. Status records are available for seven days. Possible statuses are queued, processing, canceled, completed, completed_with_errors, and failed. Up to 100 row errors are returned.
- [Daily counts](https://vida.io/docs/api-reference/tasks/daily-counts.md): Get the organization’s current daily call, text, and total Task counts.
- [Fetch task limits](https://vida.io/docs/api-reference/tasks/fetch-task-limits.md): Retrieve the org’s current task limits configuration. Business hours use a timezone plus grouped windows; days are 0 (Sunday) through 6 (Saturday).
- [Update task limits](https://vida.io/docs/api-reference/tasks/update-task-limits.md): Updates organization Task settings such as business hours, per-target cooldowns, and default retry behavior. Reseller administrators can also update call capacity. Set businessHours or defaultRetryConfiguration to null to disable that behavior.
- [Fetch a specific task](https://vida.io/docs/api-reference/tasks/fetch-a-specific-task.md): Retrieve one Task and all of its attempts. When the Task has an associated room, chatRef links directly to its scoped Vida chat. attemptHistory includes each attempt’s channel, timing, disposition, evaluation, outcomes, experiment assignment, provider reference, voicemail or delivery details, and co…
- [Update a task](https://vida.io/docs/api-reference/tasks/update-a-task.md): Updates a Task by ID. Repeating and cronOneOff Tasks support title, taskContext, state, and cronSchedule. Computer Tasks and retryable communication Tasks can only be canceled.
- [Delete a task](https://vida.io/docs/api-reference/tasks/delete-a-task.md): Deletes a non-retry Task and its schedule when applicable. Active Computer Agent work is stopped first. Active retryable communication Tasks are canceled and kept for history; completed retryable Tasks cannot be deleted.
- [Run a scheduled Task](https://vida.io/docs/api-reference/tasks/run-a-scheduled-task.md): Starts one repeating or cronOneOff Task immediately or when due. A 202 response means the run was accepted, not completed.
- [List scheduled Task runs](https://vida.io/docs/api-reference/tasks/list-scheduled-task-runs.md): Returns paginated terminal run summaries for one repeating or cronOneOff Task. Use the Task chatRef for live work and tool activity; an empty terminal history while work is active does not prove that no run started.
- [Fetch communication logs for a task](https://vida.io/docs/api-reference/tasks/fetch-communication-logs-for-a-task.md): Return Task communication logs newest first. Full transcripts are omitted from this list; use conversationRef.href to fetch conversation details and the transcript when available.
- [Cancel queued tasks](https://vida.io/docs/api-reference/tasks/cancel-queued-tasks.md): Atomically cancel pending Tasks without deleting their audit history. Provide exactly one selector: taskIds, batchId, or allPending=true. Running and terminal selected or batch Tasks are reported as skipped. Cancellation does not interrupt an in-flight attempt.
- [Fetch integration data](https://vida.io/docs/api-reference/integrations/fetch-integration-data.md): Retrieve integration configuration data for a specific integration slug and version
- [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
- [List supported AI models](https://vida.io/docs/api-reference/models/list-supported-ai-models.md): Returns the model identifiers the selected account may use for agentModel and agentThinkingModel. Use canReason to decide whether agentThinking applies.
- [List Contact Lists](https://vida.io/docs/api-reference/contacts/list-contact-lists.md): Returns the distinct persisted Contact List labels for the organization.
- [List Contacts in a Contact List](https://vida.io/docs/api-reference/contacts/list-contacts-in-a-contact-list.md): Returns one bounded page of logical Contacts in the List. Existing physical duplicate rows are collapsed before membership is evaluated.
- [Add or refresh a Contact List membership](https://vida.io/docs/api-reference/contacts/add-or-refresh-a-contact-list-membership.md): Creates the List implicitly when its first Contact is added. Re-adding a Contact refreshes one normalized membership timestamp.
- [Remove a Contact List membership](https://vida.io/docs/api-reference/contacts/remove-a-contact-list-membership.md): Removes every membership entry with the requested label. It does not infer or remove matching custom state.
- [Search and paginate Contacts](https://vida.io/docs/api-reference/contacts/search-and-paginate-contacts.md): Searches logical organization Contacts in Postgres using the standard page and pageSize pagination contract.
- [Create or update a Contact](https://vida.io/docs/api-reference/contacts/create-or-update-a-contact.md): Creates a Contact or updates the matching Contact using the documented identity fields, then returns the persisted Contact.
- [Delete a Contact](https://vida.io/docs/api-reference/contacts/delete-a-contact.md): Permanently deletes the Contact identified by id from the selected organization.
- [Remove a Contact from an objective and delete its state](https://vida.io/docs/api-reference/contacts/remove-a-contact-from-an-objective-and-delete-its-state.md): Atomically removes every matching List membership and customFields[listName].
- [Enroll a Contact in an objective and merge its state](https://vida.io/docs/api-reference/contacts/enroll-a-contact-in-an-objective-and-merge-its-state.md): Atomically ensures List membership and recursively merges the request into customFields[listName]. Explicit null removes a field. A non-object collision returns 409.
- [Fetch recent communication logs for a Contact](https://vida.io/docs/api-reference/contacts/fetch-recent-communication-logs-for-a-contact.md): Returns a concise newest-first activity index without full transcripts. Logs with roomId and uuid include conversationRef for the existing conversation-detail API.
- [Fetch one Contact](https://vida.io/docs/api-reference/contacts/fetch-one-contact.md): Returns one Contact in the selected organization by its stable Contact ID.
- [Partially update a Contact](https://vida.io/docs/api-reference/contacts/partially-update-a-contact.md): Recursively merges allowed Contact fields. Explicit null removes a field; arrays and scalars replace. The final customFields object allows at most 20 top-level keys and 8192 UTF-8 bytes.
- [List white-label domains](https://vida.io/docs/api-reference/white-label-domains/list-white-label-domains.md): Lists the domains registered to the authenticated reseller and identifies the current default domain.
- [Add a white-label domain](https://vida.io/docs/api-reference/white-label-domains/add-a-white-label-domain.md): Registers a domain to the authenticated reseller. Configure the domain according to your Vida onboarding instructions before directing users to it.
- [Remove a white-label domain](https://vida.io/docs/api-reference/white-label-domains/remove-a-white-label-domain.md): Removes a domain owned by the authenticated reseller. The current default domain cannot be removed; select another default first.
- [Set the default white-label domain](https://vida.io/docs/api-reference/white-label-domains/set-the-default-white-label-domain.md): Makes one of the authenticated reseller\'s registered domains the default domain.
- [Query conversation logs](https://vida.io/docs/api-reference/conversation-logs/query-conversation-logs.md): Returns authorized conversation logs for a time range. Select returned fields, export CSV, or filter any log field with query names such as duration__gte, eventType__in, or metadata.status__icontains. Supported suffixes are eq, ne, gt, gte, lt, lte, in, nin, contains, icontains, startswith, istartsw…
- [Calculate a conversation metric](https://vida.io/docs/api-reference/conversation-logs/calculate-a-conversation-metric.md): Calculates an aggregate metric from conversation logs for the selected account and time range. Results can also include time buckets and, for eligible reseller accounts, organization or agent comparisons. Use the normal conversation logs endpoint to inspect the records behind a metric.
- [Fetch multiple conversations](https://vida.io/docs/api-reference/conversations/fetch-multiple-conversations.md): Returns up to 200 authorized conversations in one request. Use the roomId and uuid values returned by GET /api/v2/logs.
- [Get a conversation](https://vida.io/docs/api-reference/conversations/get-a-conversation.md): Returns one authorized conversation using the roomId and uuid values returned by GET /api/v2/logs.
- [List agent apps](https://vida.io/docs/api-reference/apps/list-agent-apps.md): Lists apps available to the selected account and indicates which ones are installed and active.
- [Get agent app](https://vida.io/docs/api-reference/apps/get-agent-app.md): Returns one app manifest, including its setup requirements and whether it is installed and active for the selected account.
- [Update installed agent app](https://vida.io/docs/api-reference/apps/update-installed-agent-app.md): Updates settings for an installed app. Use reload=true to reset it to the current catalog manifest.
- [Install agent app](https://vida.io/docs/api-reference/apps/install-agent-app.md): Installs an app for the selected account. Inspect the app first and provide the app settings or authentication values its manifest requires.
- [Uninstall agent app](https://vida.io/docs/api-reference/apps/uninstall-agent-app.md): Uninstalls an app from the selected account. Remove or disable any matching app assignment in staging before publishing.
- [Get the inbound email policy](https://vida.io/docs/api-reference/inbound-email/get-the-inbound-email-policy.md): Returns whether the selected Agent accepts inbound email from any sender or only from its access list. The response also includes the current access list.
- [Update the inbound email policy](https://vida.io/docs/api-reference/inbound-email/update-the-inbound-email-policy.md): Changes the selected Agent between access-list-only and open inbound email. Read the current policy first and verify it again after the update.
- [List allowed inbound email senders](https://vida.io/docs/api-reference/inbound-email/list-allowed-inbound-email-senders.md): Returns the selected Agent's inbound email access list and current policy mode.
- [Allow an inbound email sender](https://vida.io/docs/api-reference/inbound-email/allow-an-inbound-email-sender.md): Adds one sender to the selected Agent's inbound email access list. This list controls delivery only while the policy is set to allowlist.
- [Remove an allowed inbound email sender](https://vida.io/docs/api-reference/inbound-email/remove-an-allowed-inbound-email-sender.md): Removes one sender from the selected Agent's inbound email access list. Confirm the exact address before removing it, then re-read the list.
- [Assign account features](https://vida.io/docs/api-reference/features/assign-account-features.md): Assigns one or more features to a child account. Partners may manage reseller or organization assignments; resellers may manage organization assignments. Every feature must already be granted to the caller's account.
- [Remove account features](https://vida.io/docs/api-reference/features/remove-account-features.md): Removes selected feature assignments from a child account. Read the current assignments first and confirm that dependent Agent capabilities may stop working before removing them.
- [List available account features](https://vida.io/docs/api-reference/features/list-available-account-features.md): Lists features the requesting partner or reseller may manage for the selected account. Each result identifies whether the feature is enabled and may include its assigned price. Only features granted to the parent account can be assigned to a child account.
- [Refresh Computer Agent instructions](https://vida.io/docs/api-reference/computer-agents/refresh-computer-agent-instructions.md): Reapplies Vida-managed instructions to one or all Computer Agents on the selected account and returns the result for each agent.
- [Create a Computer Agent backup](https://vida.io/docs/api-reference/computer-agents/create-a-computer-agent-backup.md): Starts an asynchronous backup of the selected Computer Agent and returns a job for tracking its progress.
- [List Computer Agent backups](https://vida.io/docs/api-reference/computer-agents/list-computer-agent-backups.md): Lists available backups and their freshness for the selected Computer Agent.
- [Get the latest backup job](https://vida.io/docs/api-reference/computer-agents/get-the-latest-backup-job.md): Returns the most recent backup request for the selected Computer Agent, or no result when one has not been started.
- [Get a backup job](https://vida.io/docs/api-reference/computer-agents/get-a-backup-job.md): Returns the current status and result of one backup request for the selected Computer Agent.
- [Restore a Computer Agent backup](https://vida.io/docs/api-reference/computer-agents/restore-a-computer-agent-backup.md): Starts an asynchronous restore from a selected backup and returns a job for tracking its progress. Restoring replaces the Computer Agent's current data. The Computer Agent is stopped and restarted automatically. Read the available backups first and poll the returned restore job until it finishes.
- [Get the latest restore job](https://vida.io/docs/api-reference/computer-agents/get-the-latest-restore-job.md): Returns the most recent restore request for the selected Computer Agent, or no result when one has not been started.
- [Get a restore job](https://vida.io/docs/api-reference/computer-agents/get-a-restore-job.md): Returns the current status and result of one restore request for the selected Computer Agent.
- [Create a browser access ticket](https://vida.io/docs/api-reference/computer-agents/create-a-browser-access-ticket.md): Creates short-lived interactive browser access for the selected Computer Agent. Open the returned launchRef.href before it expires instead of constructing a browser URL.
- [Create a Computer Agent browser automation session](https://vida.io/docs/api-reference/computer-agents/create-a-computer-agent-browser-automation-session.md): Creates a short-lived connection to the selected Computer Agent's browser. Use the returned CDP URL and request header to inspect and automate the browser, including while recording a reusable browser workflow.
- [Get Computer Agent Canvas access](https://vida.io/docs/api-reference/computer-agents/get-computer-agent-canvas-access.md): Returns the selected Computer Agent's current Canvas availability, visibility, workspace paths, and a ready-to-open URL when access is available. A public Canvas includes a stable publicUrl. A private Canvas includes only a short-lived launchRef. Visibility is read-only through this API.
- [Publish a Computer Agent Canvas](https://vida.io/docs/api-reference/computer-agents/publish-a-computer-agent-canvas.md): Prepares dependencies declared by the selected Computer Agent's Canvas project when they changed or are unavailable, builds the editable source from the app workspace directory, and replaces the generated files served from public. Read the source first, make the intended workspace changes, publish,…
- [Start a channel web-login flow](https://vida.io/docs/api-reference/computer-agents/start-a-channel-web-login-flow.md): Starts browser or QR-code sign-in for a supported channel and returns the next required step.
- [Wait for a channel web login](https://vida.io/docs/api-reference/computer-agents/wait-for-a-channel-web-login.md): Waits for a channel sign-in attempt to complete and returns its result.
- [List supported Computer Agent channels](https://vida.io/docs/api-reference/computer-agents/list-supported-computer-agent-channels.md): Lists channels that can be connected to the selected Computer Agent. Each catalog entry describes its connection fields, access controls, and current values for this Computer Agent.
- [Get Computer Agent channel status](https://vida.io/docs/api-reference/computer-agents/get-computer-agent-channel-status.md): Shows the selected Computer Agent's configured channels and their connection status. An optional live check returns current connectivity.
- [Log a channel account out](https://vida.io/docs/api-reference/computer-agents/log-a-channel-account-out.md): Disconnects the selected channel account from the Computer Agent.
- [Configure a Computer Agent channel](https://vida.io/docs/api-reference/computer-agents/configure-a-computer-agent-channel.md): Connects, updates, enables, or disables one supported channel for the selected Computer Agent. Send the channel identifier with the connection and access fields defined by the channel catalog. Vida assigns the connection and incoming messages to the selected Computer Agent automatically.
- [Get Computer Agent configuration](https://vida.io/docs/api-reference/computer-agents/get-computer-agent-configuration.md): Returns the complete redacted configuration for the selected Computer Agent, including the authored settings, effective settings, revision, validation findings, and the agents sharing the same computer. Use the revision when applying a change.
- [Update Computer Agent configuration](https://vida.io/docs/api-reference/computer-agents/update-computer-agent-configuration.md): Merges selected settings into the current Computer Agent configuration. The revision prevents an older read from overwriting a newer change. Read the configuration again after the Computer Agent finishes restarting to verify the result.
- [List Computer Agent helpers](https://vida.io/docs/api-reference/computer-agents/list-computer-agent-helpers.md): Lists reusable helpers available to the selected Computer Agent, including whether each helper requires Browser access, its exact arguments, its owning skill, and which managed secrets must be configured. Create a helper as part of a Computer Agent skill, then use this operation to verify its callab…
- [Execute a registered Computer Agent helper](https://vida.io/docs/api-reference/computer-agents/execute-a-registered-computer-agent-helper.md): Runs a registered helper for the selected Computer Agent with optional arguments. Vida supplies any managed secrets declared by the helper; secret values are never accepted in this request. Use this operation to test the exact helper and arguments before making it available to a conversational Agent…
- [Refresh and validate Computer Agent helpers](https://vida.io/docs/api-reference/computer-agents/refresh-and-validate-computer-agent-helpers.md): Rebuilds the selected Computer Agent's helper registration from the helper source files in its installed skills, then validates the registered contracts and source files. Run this after creating or changing a helper. A successful refresh means the helper is registered and its source passed validatio…
- [Provision or reconcile a Computer Agent](https://vida.io/docs/api-reference/computer-agents/provision-or-reconcile-a-computer-agent.md): Sets up the selected Computer Agent using Vida's current published version, or reconciles its existing shared Computer. Reconciliation can briefly interrupt other Agents on that Computer. Check status until the operation is terminal, then verify Computer health.
- [Deprovision a Computer Agent](https://vida.io/docs/api-reference/computer-agents/deprovision-a-computer-agent.md): Removes the shared Computer used by the selected Agent and stops Computer access for every Agent assigned to it. By default saved state is preserved so it can be provisioned again later. Permanent removal first requires a successful recent safety backup.
- [Restart a Computer Agent](https://vida.io/docs/api-reference/computer-agents/restart-a-computer-agent.md): Restarts the shared Computer used by the selected Agent. Other Agents assigned to that Computer are briefly unavailable. Check status until the operation is terminal, then verify Computer health.
- [Upgrade a Computer Agent](https://vida.io/docs/api-reference/computer-agents/upgrade-a-computer-agent.md): Upgrades the shared Computer to Vida's current published version, refreshes managed workspace templates without replacing customer Canvas or project files, and affects every Agent assigned to that Computer. Check status until the operation is terminal, then verify Computer health.
- [Get Computer Agent status](https://vida.io/docs/api-reference/computer-agents/get-computer-agent-status.md): Returns the selected Computer Agent's deployment version, readiness, and latest lifecycle operation. An unprovisioned Agent returns 404. A terminal operation remains available in the lifecycle field so callers can reconcile the accepted job before checking Computer health.
- [List Computer Agent secrets](https://vida.io/docs/api-reference/computer-agents/list-computer-agent-secrets.md): Lists saved secrets for the selected Computer Agent without returning their secret values.
- [Save a Computer Agent secret](https://vida.io/docs/api-reference/computer-agents/save-a-computer-agent-secret.md): Creates or updates a secret for the selected Computer Agent.
- [Delete a Computer Agent secret](https://vida.io/docs/api-reference/computer-agents/delete-a-computer-agent-secret.md): Deletes one secret from the selected Computer Agent. Skills or integrations that use the secret may stop working.
- [Check Computer Agent secrets](https://vida.io/docs/api-reference/computer-agents/check-computer-agent-secrets.md): Checks whether selected secrets are available to the Computer Agent without exposing their values.
- [Reapply a Computer Agent secret](https://vida.io/docs/api-reference/computer-agents/reapply-a-computer-agent-secret.md): Makes a saved secret available to the selected Computer Agent again.
- [Explore Computer Agent memories](https://vida.io/docs/api-reference/computer-agents/explore-computer-agent-memories.md): Returns memory statistics, recent items, search results, and a timeline for the selected Computer Agent. Private memories are shown by default, with options for broader accessible scopes.
- [Store a Computer Agent memory](https://vida.io/docs/api-reference/computer-agents/store-a-computer-agent-memory.md): Stores a memory for the selected Computer Agent with optional category, importance, and access settings.
- [Update a Computer Agent memory](https://vida.io/docs/api-reference/computer-agents/update-a-computer-agent-memory.md): Updates the text, category, or importance of one memory available to the selected Computer Agent. Include at least one field to change.
- [Delete a Computer Agent memory](https://vida.io/docs/api-reference/computer-agents/delete-a-computer-agent-memory.md): Permanently deletes one memory available to the selected Computer Agent.
- [Get available Computer Agent settings](https://vida.io/docs/api-reference/computer-agents/get-available-computer-agent-settings.md): Lists the supported configuration settings and accepted values for the selected Computer Agent.
- [Check Computer Agent health](https://vida.io/docs/api-reference/computer-agents/check-computer-agent-health.md): Returns whether the selected Computer Agent is healthy and ready. Use it after setup, configuration, restart, or upgrade changes.
- [Get recent Computer Agent logs](https://vida.io/docs/api-reference/computer-agents/get-recent-computer-agent-logs.md): Returns a limited page of recent logs for the selected Computer Agent with cursor pagination.
- [Get recent Computer Agent service logs](https://vida.io/docs/api-reference/computer-agents/get-recent-computer-agent-service-logs.md): Returns recent service logs for the selected Computer Agent with optional line-count and time-window limits.
- [Diagnose a Computer Agent](https://vida.io/docs/api-reference/computer-agents/diagnose-a-computer-agent.md): Runs read-only checks and returns structured findings for the computer hosting the selected agent. Findings include stable codes, severity, and affected configuration paths.
- [Repair a Computer Agent](https://vida.io/docs/api-reference/computer-agents/repair-a-computer-agent.md): Starts the supported repair operation for the computer hosting the selected agent. The operation verifies the result with read-only diagnostics. Poll the Computer Agent lifecycle status until the returned repair job finishes.
- [Start a skill authentication action](https://vida.io/docs/api-reference/computer-agents/start-a-skill-authentication-action.md): Starts one sign-in action returned by the latest skill verification. The response uses the same session fields as the sign-in status endpoint. Poll status until it returns a user handoff or a terminal result.
- [Get skill authentication action status](https://vida.io/docs/api-reference/computer-agents/get-skill-authentication-action-status.md): Returns the current status of one skill sign-in attempt. Present browserNavigateUrl or capturedDeviceCode to the user when provided. Continue polling until status is succeeded, failed, or cancelled, then verify the skill again.
- [Cancel a skill authentication action](https://vida.io/docs/api-reference/computer-agents/cancel-a-skill-authentication-action.md): Cancels one active skill sign-in attempt. Use this only when the user abandons the sign-in or the current attempt must be restarted.
- [List available Computer Agent skills](https://vida.io/docs/api-reference/computer-agents/list-available-computer-agent-skills.md): Lists skills available to the selected Computer Agent and shows whether each one is currently installed and ready. Use a skill's skillSlug to read its detail before installation.
- [Get Computer Agent skill details](https://vida.io/docs/api-reference/computer-agents/get-computer-agent-skill-details.md): Returns the description, installation options, current readiness, and latest verification for one available skill. After installation, use verification.requiredActions as the current setup plan.
- [Get installed Computer Agent skills](https://vida.io/docs/api-reference/computer-agents/get-installed-computer-agent-skills.md): Returns the installed skills and their current state for the selected Computer Agent.
- [Get a Computer Agent skill setup value](https://vida.io/docs/api-reference/computer-agents/get-a-computer-agent-skill-setup-value.md): Reads a setup storage key declared by the selected skill. The response returns non-sensitive values and reports whether sensitive values are already configured without returning their contents.
- [Install a Computer Agent skill](https://vida.io/docs/api-reference/computer-agents/install-a-computer-agent-skill.md): Installs one skill returned by the Computer Agent skill catalog. Read the skill detail first and select an installation option when more than one is available. Verify the skill immediately after installation to obtain its current setup requirements.
- [Verify an installed skill](https://vida.io/docs/api-reference/computer-agents/verify-an-installed-skill.md): Checks whether the selected skill is installed and configured. Treat the returned requiredActions as the current setup plan, complete them in order while respecting dependsOn, and verify again until setupComplete is true.
- [Disable an installed skill](https://vida.io/docs/api-reference/computer-agents/disable-an-installed-skill.md): Disables one installed skill without deleting its saved setup.
- [Uninstall an installed skill](https://vida.io/docs/api-reference/computer-agents/uninstall-an-installed-skill.md): Removes one skill from the selected Computer Agent and disables the capability it provides.
- [Save a Computer Agent skill setting](https://vida.io/docs/api-reference/computer-agents/save-a-computer-agent-skill-setting.md): Saves one non-sensitive setup value declared by the skill's current required actions. Use the managed skill-configuration endpoint for sensitive values.
- [List Computer Agent tools and policy](https://vida.io/docs/api-reference/computer-agents/list-computer-agent-tools-and-policy.md): Lists tools available to the selected Computer Agent and whether each tool is currently allowed.
- [Change one Computer Agent tool policy](https://vida.io/docs/api-reference/computer-agents/change-one-computer-agent-tool-policy.md): Allows or blocks one supported tool for the selected Computer Agent.
- [Run an allowed Computer Agent tool](https://vida.io/docs/api-reference/computer-agents/run-an-allowed-computer-agent-tool.md): Runs one tool returned by the Computer Agent tool catalog and returns its result. Prefer a purpose-built endpoint when one is available.
- [Get browser workflow status](https://vida.io/docs/api-reference/computer-agents/get-browser-workflow-status.md): Shows recording and browser-helper generation status. Active generation includes a conversation reference that explains how to open its live Vida chat.
- [Start recording a browser workflow](https://vida.io/docs/api-reference/computer-agents/start-recording-a-browser-workflow.md): Starts a browser workflow recording for the selected Computer Agent. When using a browser automation session, pass the exact slot returned by that session.
- [Stop recording a browser workflow](https://vida.io/docs/api-reference/computer-agents/stop-recording-a-browser-workflow.md): Stops and finalizes the active browser workflow recording for the selected Computer Agent.
- [Add guidance to a browser workflow recording](https://vida.io/docs/api-reference/computer-agents/add-guidance-to-a-browser-workflow-recording.md): Adds written guidance and structured notes to a finalized browser workflow recording.
- [Delete a browser workflow recording](https://vida.io/docs/api-reference/computer-agents/delete-a-browser-workflow-recording.md): Deletes the selected finalized browser workflow recording.
- [Generate a reusable browser helper](https://vida.io/docs/api-reference/computer-agents/generate-a-reusable-browser-helper.md): Starts browser-helper generation from the finalized recordings for the selected domain. The response includes the resulting skill identifier and a conversation reference for following the Computer Agent's work and tool calls. Supply a neutral skill name when the domain contains customer-specific inf…
- [Reset a generated browser helper](https://vida.io/docs/api-reference/computer-agents/reset-a-generated-browser-helper.md): Removes the generated browser helper for the selected domain while preserving its recordings.
- [Read a Computer Agent workspace file](https://vida.io/docs/api-reference/computer-agents/read-a-computer-agent-workspace-file.md): Returns the text content of one customer-created, workspace-relative file. Canvas source is available under app even though that directory is omitted from root listings. Use the agent configuration workflow for agent instructions and settings.
- [Write a Computer Agent workspace file](https://vida.io/docs/api-reference/computer-agents/write-a-computer-agent-workspace-file.md): Writes complete text content to one customer-created, workspace-relative file. This replaces an existing file or creates a new file and any missing parent folders. Canvas source is editable under app and must be published separately. Use the agent configuration workflow for agent instructions and se…
- [Upload a Computer Agent workspace file](https://vida.io/docs/api-reference/computer-agents/upload-a-computer-agent-workspace-file.md): Uploads one customer-created file to the selected Computer Agent workspace. Set overwrite to true to replace an existing file. Agent instructions, settings, and protected system files cannot be uploaded through this endpoint.
- [List a Computer Agent workspace directory](https://vida.io/docs/api-reference/computer-agents/list-a-computer-agent-workspace-directory.md): Lists customer-created files and folders at an optional workspace-relative directory. Omit path to list the ordinary workspace root. Canvas source is intentionally omitted there but can be listed directly with path app. Agent instructions and settings do not appear in customer results; update them t…
- [Delete a Computer Agent workspace path](https://vida.io/docs/api-reference/computer-agents/delete-a-computer-agent-workspace-path.md): Deletes one customer-created file or empty directory from the selected Computer Agent workspace. Agent instructions, settings, and protected system files cannot be deleted here.
- [Download a Computer Agent workspace file](https://vida.io/docs/api-reference/computer-agents/download-a-computer-agent-workspace-file.md): Downloads one customer-created file from the selected Computer Agent workspace.
- [Preview a Computer Agent workspace file](https://vida.io/docs/api-reference/computer-agents/preview-a-computer-agent-workspace-file.md): Previews one supported customer-created file from the selected Computer Agent workspace.
- [Replace text in a Computer Agent workspace file](https://vida.io/docs/api-reference/computer-agents/replace-text-in-a-computer-agent-workspace-file.md): Replaces the first exact occurrence of text in a customer-created, workspace-relative file. Read the file first and verify it again after editing. Use the agent configuration workflow for agent instructions and settings.
- [Find workspace paths](https://vida.io/docs/api-reference/computer-agents/find-workspace-paths.md): Finds customer-created, workspace-relative file and folder names containing a pattern. Search the whole visible workspace by omitting path, or limit the search to one directory. Agent instructions and settings are not included.
- [Search text in a Computer Agent workspace](https://vida.io/docs/api-reference/computer-agents/search-text-in-a-computer-agent-workspace.md): Finds plain text within a customer-created, workspace-relative file or directory. Results can be limited by file pattern, capitalization, surrounding lines, and maximum count. Agent instructions and settings are not searchable here.
- [List Computer Agent accounts](https://vida.io/docs/api-reference/computer-agents/list-computer-agent-accounts.md): Lists the Computer Agent accounts available to the requester, including whether their shared Computer is configured and which account is the default.
- [List Computer Agent sessions](https://vida.io/docs/api-reference/computer-agent-sessions/list-computer-agent-sessions.md): Lists Computer Agent sessions visible to the authenticated user with pagination and optional filters.
- [Reset a Computer Agent session](https://vida.io/docs/api-reference/computer-agent-sessions/reset-a-computer-agent-session.md): Resets one authorized Computer Agent session. This discards its active conversational context.
- [Find a Computer Agent session chat](https://vida.io/docs/api-reference/computer-agent-sessions/find-a-computer-agent-session-chat.md): Returns the Vida chat associated with an authorized session for the selected Computer Agent, including a direct messages reference when the chat is available. Omit sessionKey to resolve the default direct session for the requester and selected agent.
- [Suggest template fields from a website](https://vida.io/docs/api-reference/agent-templates/suggest-template-fields-from-a-website.md): Reads a public website and suggests values for an existing Agent template draft. Review every suggestion before saving or applying the template.
- [Create an Agent from a template](https://vida.io/docs/api-reference/agent-templates/create-an-agent-from-a-template.md): Applies a reseller template to the selected Agent account, creates staging and live Agent configurations, and publishes the result. Supply values for the template's declared fields and verify the returned live configuration before using it.
- [Detach an Agent from its template](https://vida.io/docs/api-reference/agent-templates/detach-an-agent-from-its-template.md): Removes template ownership and editable-field restrictions from the selected Agent, then publishes the detached configuration. The Agent keeps its current authored configuration.
- [Migrate Agents to a template revision](https://vida.io/docs/api-reference/agent-templates/migrate-agents-to-a-template-revision.md): Starts a migration for Agents created from this template. A dry run is used by default. Review its result before setting dryRun to false. Use sectionsToMigrate to limit the change and avoid forcing over customer overrides unless that replacement is explicitly intended.
- [List template migrations](https://vida.io/docs/api-reference/agent-templates/list-template-migrations.md): Lists recent migrations for an Agent template owned by the selected reseller. The optional limit query value controls how many recent migrations are returned.
- [Get a template migration](https://vida.io/docs/api-reference/agent-templates/get-a-template-migration.md): Returns the current status and result for one template migration. Poll this operation until the migration reaches a terminal state before reporting completion.
- [List Agent templates](https://vida.io/docs/api-reference/agent-templates/list-agent-templates.md): Lists reusable Agent templates available to the selected account. By default, disabled templates are excluded. Use includeHidden only when the caller is allowed to manage hidden templates.
- [Create an Agent template draft](https://vida.io/docs/api-reference/agent-templates/create-an-agent-template-draft.md): Creates a disabled template draft for the selected reseller. Read the returned template, update its Agent configuration and onboarding fields, then enable it only after testing it.
- [Get an Agent template](https://vida.io/docs/api-reference/agent-templates/get-an-agent-template.md): Returns one Agent template owned by the selected reseller. Use this response as the starting point for updates so fields outside the intended change are preserved.
- [Update an Agent template](https://vida.io/docs/api-reference/agent-templates/update-an-agent-template.md): Updates the supplied fields on an Agent template owned by the selected reseller. Read the current template first and preserve fields that are not part of the requested change.
- [Delete an Agent template](https://vida.io/docs/api-reference/agent-templates/delete-an-agent-template.md): Deletes a disabled Agent template owned by the selected reseller. Disable the template and confirm it is no longer needed before deleting it.

## OpenAPI Specs

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