Create Connection | BCTRL Docs

Create a short-lived connection lease for a live runtime. Use this to mint credentials for a third-party client that needs to attach to the runtime.

AuthorizationBearer

Use Bearer <api-key>.

idstringRequired

runtimeIdstringRequired

This endpoint expects an object.

protocolenumRequired

Allowed values:

optionsmap from strings to anyOptional

ttlSecondsintegerOptional60-7200

Default Response

closedAtdatetime or null

createdAtdatetime

endpointobject

expiresAtdatetime or null

idstringformat: "uuid"

protocolenum

revokedAtdatetime or null

runIdstringformat: "uuid"

runtimeIdstringformat: "uuid"

status"active"

1	curl -X POST https://api.bctrl.ai/v1/spaces/id/runtimes/runtimeId/connections \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"protocol": "cdp"
6	}'

1	{
2	"closedAt": "2024-01-15T10:30:00Z",
3	"createdAt": "2024-01-15T08:30:00Z",
4	"endpoint": {
5	"type": "websocket",
6	"url": "wss://runtime-connection.bctrl.ai/session/abc123"
7	},
8	"expiresAt": "2024-01-15T10:30:00Z",
9	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10	"protocol": "cdp",
11	"revokedAt": "2024-01-15T09:45:00Z",
12	"runId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
13	"runtimeId": "1c9e6679-7425-40de-944b-e07fc1f90ae7",
14	"status": "active"
15	}