Create a Runtime | BCTRL Docs

{
  "activeRunId": "d4f5a6b7-c8d9-4e0f-9a1b-2c3d4e5f6789",
  "createdAt": "2024-01-15T09:30:00Z",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Development Browser Runtime",
  "spaceId": "f1e2d3c4-b5a6-7890-1234-56789abcdef0",
  "status": "stopped",
  "type": "browser",
  "updatedAt": "2024-01-15T09:30:00Z",
  "config": {
    "profile": true,
    "autoUpgrade": true,
    "extensionIds": [
      "ext_adblocker123"
    ],
    "fingerprint": {
      "browser": "chrome",
      "locale": "en-US",
      "timezone": "America/New_York",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
      "viewport": {
        "height": 900,
        "width": 1440
      }
    },
    "forceOpenShadowRoots": false,
    "idleTimeoutMinutes": 15,
    "networkTraffic": {
      "blockAds": true,
      "blockResourceTypes": [
        "media",
        "image",
        "font"
      ],
      "blockTrackers": true,
      "saver": "medium",
      "urlAllowlist": [
        "https://trustedsite.com"
      ],
      "urlBlocklist": [
        "https://ads.example.com",
        "https://tracking.example.net"
      ]
    },
    "proxy": {
      "id": "proxy-1234abcd-5678-efgh-ijkl-9012mnopqrst",
      "name": "Corporate Proxy",
      "type": "custom"
    },
    "stealth": "high",
    "webRtcProxyOnly": false
  },
  "lastActivityAt": "2024-01-15T09:30:00Z",
  "metadata": {}
}

Create a stopped browser runtime and return the simplified runtime detail resource. Omit spaceId to use the caller's default space.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Request

This endpoint expects an object.

configobjectOptional

metadataobjectOptional

namestringOptional1-120 characters

spaceIdstring or "default"Optional

type"browser"Optional

Response

Created

activeRunIdstring or nullformat: "uuid"

createdAtdatetime

idstringformat: "uuid"

namestring>=1 character

spaceIdstringformat: "uuid"

statusenum

type"browser"

updatedAtdatetime

configobject

lastActivityAtdatetime

metadataobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

$	curl -X POST https://api.bctrl.ai/v1/runtimes \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'