Create a runtime inside a workspace

POST

/v1/workspaces/:id/runtimes

POST

/v1/workspaces/:id/runtimes

1 curl -X POST https://api.bctrl.ai/v1/workspaces/id/runtimes \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "alias": "TestBrowser01",
6   "kind": "browser"
7 }'

200Successful

1 {
2   "alias": "TestBrowser01",
3   "createdAt": "2024-06-01T10:15:30Z",
4   "driver": "playwright",
5   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6   "kind": "browser",
7   "status": "active",
8   "updatedAt": "2024-06-01T10:20:45Z",
9   "workspaceId": "9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f",
10   "summary": {
11     "browserRunning": true,
12     "currentDriver": "playwright",
13     "defaultContextId": "context-1234",
14     "defaultPageId": "page-5678",
15     "launchMode": "profile",
16     "profileId": "1e2d3c4b-5a6f-7e8d-9c0b-1a2b3c4d5e6f",
17     "storageWorkspace": "workspace-storage-01"
18   }
19 }

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Request

This endpoint expects an object.

objectRequired

Response

Default Response

aliasstringformat: "^[A-Za-z][A-Za-z0-9_-]{0,63}$"

createdAtstring

driverstring>=1 character

idstringformat: "uuid"

kindenum

Allowed values:

statusenum

Allowed values:

updatedAtstring

workspaceIdstringformat: "uuid"

summaryobject or null