Wait for a durable operation to complete or time out waiting

POST

/v1/operations/:id/wait

POST

/v1/operations/:id/wait

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

200Successful

1 {
2   "operation": {
3     "createdAt": "2024-06-01T15:00:00Z",
4     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5     "runtime": "chrome_102",
6     "runtimeId": "1e2d3c4b-5a6f-7e8d-9c0b-1a2b3c4d5e6f",
7     "runtimeKind": "browser",
8     "status": "running",
9     "workspaceId": "9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f",
10     "cancelRequestedAt": "2024-06-01T15:45:30Z",
11     "currentCall": "initializeSession",
12     "error": {
13       "message": "The requested session could not be found.",
14       "code": "SESSION_NOT_FOUND",
15       "details": {}
16     },
17     "finishedAt": "2024-06-01T15:30:00Z",
18     "lastHeartbeatAt": "2024-06-01T15:29:55Z",
19     "progress": {
20       "currentCall": "loadPage",
21       "lastEventType": "navigation",
22       "message": "Loading main dashboard page",
23       "step": 3,
24       "totalSteps": 5
25     },
26     "result": {
27       "mode": "fail-fast",
28       "ok": true,
29       "runtime": "chrome_102",
30       "steps": [
31         {
32           "binding": {
33             "alias": "mainPage",
34             "id": "page-1234",
35             "type": "page"
36           },
37           "call": "navigateToDashboard",
38           "index": 0,
39           "ok": true,
40           "resolved": {
41             "call": "navigateToDashboard",
42             "contextId": "ctx-5678",
43             "handleId": "handle-9012",
44             "method": "goto",
45             "pageId": "page-1234",
46             "ref": "ref-3456",
47             "sessionId": "session-7890",
48             "target": "https://dashboard.bctrl.ai"
49           }
50         }
51       ]
52     },
53     "startedAt": "2024-06-01T15:00:05Z"
54   },
55   "timedOutWaiting": false
56 }

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Request

This endpoint expects an object.

timeoutMsintegerOptional<=120000

Response

Default Response

operationobject

timedOutWaitingboolean