Skip to main content
The Vida API Skill is a machine-readable operating guide for AI agents that configure and manage Vida through the API. It complements the generated OpenAPI reference with account-scoping rules, safe workflows, verification requirements, and ready-to-use request patterns.

​
What the skill covers

  • authentication and account scope
  • Contacts and Contact-centered objectives
  • communication, retry, Computer, repeating, and one-off Tasks
  • Agent configuration, versions, experiments, reporting fields, and metrics
  • phone numbers, SIP registration, inbound SIP access, and outbound SIP routing
  • organization and Agent onboarding, plus optional reseller and partner account workflows
  • reseller Agent templates, feature inheritance, members, API tokens, inbound email, and webhooks
  • white-label domains and embedded customer access when those capabilities are enabled
  • Computer Agent provisioning and operations
  • skills, managed credentials, channels, workspace files, browser automation, memory, and diagnostics
  • logs, conversations, and incident investigation
The skill does not grant access to Vida. Every request still requires a Vida API token with permission for the selected account. The skill starts by reading the authenticated account type. It does not assume every customer has a reseller or partner hierarchy, and it does not expose private enablement routes. Optional outbound number pools are documented as a Vida-enabled Task capability rather than a self-service API.

​
Source and updates

The canonical source is VIDA-Global/vida-skill. Install or reference that repository using the skill mechanism supported by your AI agent. Different agent runtimes use different installation commands, so use the runtime’s documented skill-installation process rather than copying a command intended for another product. Vida-managed Computer Agents receive a managed copy of the skill. Canonical updates are synchronized from the source repository; do not maintain a separate edited copy unless you intentionally want a fork.

​
Required environment

The skill expects:
  • VIDA_API_BASE_URL, normally https://api.vida.dev
  • VIDA_API_KEY, containing the authorized Vida API token
Configure the API key as a secure environment variable rather than embedding it in source files or prompts.

​
How an AI agent should use it

  1. Load the current skill before operating the Vida API.
  2. Read the current OpenAPI document for exact request and response schemas.
  3. Resolve the exact account and configuration identifiers required by the workflow.
  4. Read current state before making changes.
  5. Apply the smallest intended change.
  6. Re-read the affected resource and verify the real capability before reporting completion.
The OpenAPI document is authoritative for endpoint shape. The skill is authoritative for operational sequencing and safety guidance. The API cookbooks provide end-to-end acceptance flows for launching an Agent, running outbound work, investigating an incident, and onboarding an eligible reseller customer. An AI agent should use them with the skill rather than replacing the skill’s current account-scoping and safety rules.

​
When to use the skill

Use it when an AI agent is helping a Vida customer or employee set up, configure, operate, or troubleshoot Vida resources. Human-oriented product guidance remains in the Documentation tab; this skill is designed for agents performing API work.