Connect your own connector
Makes a connection of a connector that has a live version. The credentials are not in this body: save each in your vault first (POST /v1/connections, encrypted at rest) and give its id here. webhook verifies what the provider sends (a signing secret, a public key or a secret token, by the connector's declared scheme); handshakeToken answers an unsigned subscription check (needed when the connector declares one); primary is what its sends and live connection sign in with (needed when it declares either). host is one of the hosts the connector declares (needed when it declares more than one). With an agentId the agent answers at once; without it the connection waits as NEEDS_INPUT until POST /v1/connector-connections/{id}/bind. The answer carries webhookUrl: the address to give the provider.
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.
name*stringThe connector name: the last part of ws/<workspace>/<name>.
application/json- body
displayName*stringA name for this connection (1 to 120 characters).
1 <= length <= 120credentials*Vault ids: webhook, handshakeToken and primary, as the connector needs them.
host?stringWhich declared host sends go to (optional when the connector declares one).
1 <= length <= 253authType?stringHow the primary credential is presented: bearer, basic, api_key, oauth2 or none.
"oauth2""api_key""bearer""basic""none"credentialPlacement?||Where the primary credential goes on a request: a header, a path prefix holding {secret}, or a query parameter.
agentId?stringThe agent that answers through the connection (optional).
1 <= lengthThe connection, and the address to give the provider
application/json- response
connectionId*stringuuidconnectorId*string1 <= lengthdisplayName*stringstatus*stringhost*string|nullwebhookUrl*string1 <= lengthbound*booleancurl -X POST "https://api.vlayers.ai/v1/workspace-connectors/$CONNECTOR_NAME/connections" \ -H "Authorization: Bearer $VOICELAYER_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "displayName": "Support bot", "credentials": { "webhook": "0192f5c3-7a8b-7cad-9e2f-3a4b5c6d7e89", "primary": "0192f5c4-8b9c-7dbe-8f30-4b5c6d7e8f9a" } }'{ "connectionId": "0192f5c3-7a8b-7cad-9e2f-3a4b5c6d7e89", "connectorId": "ws/0192f5a1-5e6f-7a7b-8c8d-9e0f1a2b3c45/telegram", "displayName": "Support bot", "status": "READY", "host": "api.telegram.org", "webhookUrl": "https://api.vlayers.ai/v1/connector-webhooks/ws%2F0192f5a1-5e6f-7a7b-8c8d-9e0f1a2b3c45%2Ftelegram/0192f5c3-7a8b-7cad-9e2f-3a4b5c6d7e89", "bound": true}