Wait for Run Event | BCTRL Docs

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

{
  "cursor": "eyJldmVudElkIjoiMTIzNDU2Nzg5MCJ9",
  "event": {
    "id": "evt-123456",
    "kind": "command",
    "runId": "4a1b2c3d-4e5f-6789-abcd-ef0123456789",
    "runtimeId": "9f8e7d6c-5b4a-3210-fedc-ba9876543210",
    "runtimeKind": "browser",
    "source": "platform",
    "spaceId": "7e6f5d4c-3b2a-1098-7654-3210fedcba98",
    "time": "2024-06-01T12:34:56Z",
    "type": "command-execution",
    "artifactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "commandId": "cmd-7890",
    "connectionId": "1c6b147e-8f3a-4d2a-9f3e-2a1b4c5d6e7f",
    "contextId": "ctx-4567",
    "correlationId": "corr-1234",
    "data": {},
    "name": "ExecuteScript",
    "pageId": "page-9876",
    "status": "completed",
    "toolCallId": "toolcall-5678"
  },
  "timedOut": false
}

Wait until the next matching run event is available. Use this when automation needs to block on a command, connection, runtime, artifact, tool, or browser signal.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Request

This endpoint expects an object.

connectionIdstringOptionalformat: "uuid"

contextIdstringOptional

cursorstringOptional>=1 character

kindlist of enumsOptional

pageIdstringOptional

sourcelist of enumsOptional

Allowed values:

timeoutMsintegerOptional<=120000

typelist of stringsOptional

Response

Default Response

cursorstring or null

eventobject or null

timedOutboolean