Install a package
Installs one published version in your workspace. You agree to the hash of the summary you read (consentToSummary); if the version changed since, nothing is installed and the answer carries the new summary. The package runs in your own rooms, from a sealed copy of the version, and only if its publisher's signature verifies. Every install is recorded with who agreed and to which summary.
Requires an API key with the workspace:write scope.
apiKeyAuthorizationBearer <token>A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.
application/json- body
packageId*stringThe package, as <namespace>/<name>.
1 <= length <= 200versionId*stringThe id of the published version to install.
1 <= length <= 200consentToSummary*stringThe summary.hash you read in the preview.
^[0-9a-f]{64}$sizeClass?stringThe room size to run it in: small (default), medium or large.
"small""small""medium""large"warmCount?integerHow many copies to keep ready (1 to 20, default 1).
1 <= value <= 201updateMode?stringmanual (default): every new version waits for your word. automatic: a version that does not widen what the package can do installs by itself.
"manual""manual""automatic"The install
application/json- response
id*stringuuidpackageId*stringkind*string"connector""tool-set""agent-template""mcp-server""plugin"publisherWorkspaceId*stringversionId*stringlabel*stringstate*string"active""stopped"updateMode*string"manual""automatic"summary*consentedBy*stringconsentedAt*stringdate-timenotice*|nullpendingUpdate*|nullsizeClass*string"small""medium""large"warmCount*integerscreens*booleancurl -X POST https://api.vlayers.ai/v1/installs \ -H "Authorization: Bearer $VOICELAYER_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "packageId": "com.example/orders-panel", "versionId": "0192f5c1-5e6f-7a8b-9c0d-1e2f3a4b5c67", "consentToSummary": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" }'{ "id": "0192f5c3-7a8b-7c9d-8e1f-3a4b5c6d7e89", "packageId": "com.example/orders-panel", "kind": "tool-set", "publisherWorkspaceId": "org_publisher", "versionId": "0192f5c1-5e6f-7a8b-9c0d-1e2f3a4b5c67", "label": "com.example/[email protected]", "state": "active", "updateMode": "manual", "summary": { "lines": [ { "section": "hosts", "key": "host:api.example.com", "text": "It can send data to api.example.com." } ], "hash": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" }, "consentedBy": "user_2abc", "consentedAt": "2026-10-20T15:04:05.000Z", "notice": null, "pendingUpdate": null, "sizeClass": "small", "warmCount": 1, "screens": false}