Publish a version of your connector

POST
/v1/workspace-connectors/{name}/versions

Seals a version from a manifest (what the connector verifies, reads, sends and keeps open: inbound, sends, live, egressHosts) and an image by digest, and starts its room. The manifest's id must be ws/<your workspace>/<name>, and only attribution from the URL is served. A manifest with problems is refused with 422 manifest_invalid, each problem with its path; a tag, or an image from another repository, with 422 image_refused. The answer is 202: the version goes live once its room has registered, and GET /v1/workspace-connectors/{name}/versions/{version} says how that is going.

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.

Path Parameters

name*string

The connector name: the last part of ws/<workspace>/<name>.

Request Body

application/json
  1. body
manifest*

The connector manifest (an object). It names no secret: credentials stay with each connection.

image*string

The pushed image, by digest: sha256:… or registry.vlayers.ai/<workspace>/<connector>@sha256:…. A tag is refused.

Length1 <= length <= 512
note?string

A note kept with the version (up to 500 characters).

Lengthlength <= 500

Response Body

Accepted: the version waits for its room to register

application/json
  1. response
connectorId*string
Length1 <= length
version*integer
Range1 <= value
versionId*string
Formatuuid
state*string
Value in"sealed""published""superseded""failed"
manifestHash*string
Match^[0-9a-f]{64}$
image*
rooms*array<>
failure*|null
Example Request
curl -X POST "https://api.vlayers.ai/v1/workspace-connectors/$CONNECTOR_NAME/versions" \  -H "Authorization: Bearer $VOICELAYER_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "manifest": {      "id": "ws/org_1234/telegram",      "displayName": "Telegram",      "channels": [        "web"      ],      "inbound": {        "verification": {          "scheme": "secret_token_header",          "header": "x-telegram-bot-api-secret-token"        },        "events": [          {            "kind": "message",            "id": {              "from": "json",              "path": "update_id"            }          }        ]      },      "egressHosts": [        "api.telegram.org"      ]    },    "image": "sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"  }'
Example Response
{  "connectorId": "ws/0192f5a1-5e6f-7a7b-8c8d-9e0f1a2b3c45/telegram",  "version": 3,  "versionId": "0192f5d5-9cad-7ebf-9a4b-5c6d7e8f9012",  "state": "sealed",  "manifestHash": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",  "image": {    "digest": "sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",    "repository": "registry.vlayers.ai/0192f5a1-5e6f-7a7b-8c8d-9e0f1a2b3c45/0192f5c2-6f7a-7b9c-8d1e-2f3a4b5c6d78",    "workspaceId": "0192f5a1-5e6f-7a7b-8c8d-9e0f1a2b3c45",    "agentId": "0192f5c2-6f7a-7b9c-8d1e-2f3a4b5c6d78",    "pushedAt": "2026-10-20T15:04:05.000Z",    "sizeBytes": 148000000,    "platform": "linux/amd64",    "scan": {      "status": "complete",      "scanner": "trivy",      "scannedAt": "2026-10-20T15:04:05.000Z",      "findings": {        "critical": 0,        "high": 1,        "medium": 4,        "low": 9,        "unknown": 0      },      "reportRef": null,      "error": null    },    "sbom": {      "format": "spdx-json",      "ref": "sbom/0123456789ab.json"    },    "referencedBy": 1  },  "rooms": [    {      "id": "room_0192f5d4-8b9c-7dae-8f3a-4b5c6d7e8f90",      "state": "starting",      "stateChangedAt": "2026-10-20T15:04:05.000Z"    }  ],  "failure": null}