Read what a package can do

POST
/v1/installs/preview

Shows what a published version of a package can do, worked out by VoiceLayer from its signed manifest rather than written by the publisher: the places it can send data, the credentials and connections it asks for, the messages it sends, the addresses it publishes. Nothing is installed. The summary.hash is what you agree to when you install.

Requires an API key with the workspace:read 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 read.

Length1 <= length <= 200
sizeClass?string

The room size you would run it in: small, medium or large.

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

How many copies you would keep ready (1 to 20).

Range1 <= value <= 20
Default1

Response Body

What the package can do, derived by the platform from its signed manifest; the hash is what an install consents to

application/json
  1. response
packageId*string
versionId*string
label*string
kind*string
Value in"connector""tool-set""agent-template""mcp-server""plugin"
publisherWorkspaceId*string
summary*
caveat*string
Example Request
curl -X POST https://api.vlayers.ai/v1/installs/preview \  -H "Authorization: Bearer $VOICELAYER_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "packageId": "com.example/orders-panel",    "versionId": "0192f5c1-5e6f-7a8b-9c0d-1e2f3a4b5c67"  }'
Example Response
{  "packageId": "com.example/orders-panel",  "versionId": "0192f5c1-5e6f-7a8b-9c0d-1e2f3a4b5c67",  "label": "com.example/[email protected]",  "kind": "tool-set",  "publisherWorkspaceId": "org_publisher",  "summary": {    "lines": [      {        "section": "hosts",        "key": "host:api.example.com",        "text": "It can send data to api.example.com."      }    ],    "hash": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"  },  "caveat": "This package can send the data it receives to these hosts. Treat it as you would any vendor with that access."}