Install an app
- List the selected account’s catalog with
GET /api/v2/apps?targetAccountId=.... - Read the selected app and version. Its manifest describes authentication and required settings and reports whether it is installed and active.
- Install it with
POST /api/v2/apps/{appId}/{appVersion}?targetAccountId=..., supplying only settings declared by the manifest. - Read it again and verify
installed: trueandactive: true.
PUT on the same app path to update an installation.
Assign an app to an Agent
Add an entry containingappId, 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 callingDELETE 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.