Wait For Run Event

POST

/v2/runs/:id/events/wait

POST

/v2/runs/:id/events/wait

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

200Successful

1 {
2   "cursor": "eyJwYWdlIjoyLCJpZCI6IjY1ZjYxYjYxLTQ3YjktNDYxYS1hYjYxLTI3YjYxYjYxYjYxNiJ9",
3   "data": {
4     "category": "runtime",
5     "id": "evt-1234567890",
6     "runId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
7     "runtimeId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
8     "runtimeType": "browser",
9     "time": "2024-06-01T12:00:00Z",
10     "type": "event",
11     "commandId": "cmd-8f3a2b7d",
12     "connectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
13     "data": {},
14     "fileId": "1c9d4f2e-3b7a-4d2a-9f3e-2a1b4c5d6e7f",
15     "invocationId": "inv-0987654321",
16     "name": "RuntimeStarted",
17     "status": "success",
18     "toolCallId": "toolcall-4567"
19   },
20   "timedOut": false
21 }

Wait for the next matching run event.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Request

This endpoint expects an object.

categorylist of enumsOptional

connectionIdstringOptionalformat: "uuid"

cursorstringOptional>=1 character

timeoutMsintegerOptional<=120000

typelist of stringsOptional

Response

Default Response

cursorstring or null

dataobject or null

timedOutboolean