Skip to main content
Vida apps connect Agents to external services. They are different from built-in Agent functions, Computer Agent skills and helpers, and webhooks.

Install an app

  1. List the selected account’s catalog with GET /api/v2/apps?targetAccountId=....
  2. Read the selected app and version. Its manifest describes authentication and required settings and reports whether it is installed and active.
  3. Install it with POST /api/v2/apps/{appId}/{appVersion}?targetAccountId=..., supplying only settings declared by the manifest.
  4. Read it again and verify installed: true and active: true.
Use PUT on the same app path to update an installation.

Assign an app to an Agent

Add an entry containing appId, version, instructions, and enabled state to the staging Agent’s apps array. Preserve existing assignments that should remain. Read staging, test the integration, publish, and verify the live configuration.

Uninstall safely

Before calling DELETE on an app installation, remove or disable its assignment in staging and publish. This prevents the live Agent from being instructed to use an unavailable integration. Never guess app credentials or configuration fields. Read the current manifest because requirements differ by app and version.