Install a package

POST
/v1/installs

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.

Authorization

apiKey
headerAuthorizationBearer <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.

Request Body

application/json
  1. body
packageId*string

The package, as <namespace>/<name>.

Length1 <= length <= 200
versionId*string

The id of the published version to install.

Length1 <= length <= 200
consentToSummary*string

The summary.hash you read in the preview.

Match^[0-9a-f]{64}$
sizeClass?string

The room size to run it in: small (default), medium or large.

Default"small"
Value in"small""medium""large"
warmCount?integer

How many copies to keep ready (1 to 20, default 1).

Range1 <= value <= 20
Default1
updateMode?string

manual (default): every new version waits for your word. automatic: a version that does not widen what the package can do installs by itself.

Default"manual"
Value in"manual""automatic"

Response Body

The install

application/json
  1. response
id*string
Formatuuid
packageId*string
kind*string
Value in"connector""tool-set""agent-template""mcp-server""plugin"
publisherWorkspaceId*string
versionId*string
label*string
state*string
Value in"active""stopped"
updateMode*string
Value in"manual""automatic"
summary*
consentedBy*string
consentedAt*string
Formatdate-time
notice*|null
pendingUpdate*|null
sizeClass*string
Value in"small""medium""large"
warmCount*integer
screens*boolean
Example Request
curl -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"  }'
Example Response
{  "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}