Wait For Invocation

POST

/v2/invocations/:id/wait

POST

/v2/invocations/:id/wait

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

200Successful

1 {
2   "data": {
3     "artifactCount": 3,
4     "createdAt": "2024-06-01T12:00:00Z",
5     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6     "runId": "1c6b147e-8f3a-4d2a-9f3e-1a2b3c4d5e6f",
7     "runtimeId": "7e4a9b2c-3d1f-4a5b-8c7d-9e0f1a2b3c4d",
8     "runtimeType": "browser",
9     "spaceId": "9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f",
10     "status": "failed",
11     "type": "data-processing",
12     "durationMs": 4500,
13     "error": {
14       "message": "The invocation exceeded the allowed time limit.",
15       "code": "INVOCATION_TIMEOUT",
16       "details": {}
17     },
18     "finishedAt": "2024-06-01T12:00:05Z",
19     "metadata": {},
20     "progress": {
21       "message": "Processing step 2 of 5",
22       "step": 2,
23       "totalSteps": 5
24     },
25     "result": {},
26     "startedAt": "2024-06-01T11:59:55Z"
27   },
28   "timedOut": false
29 }

Wait for a durable invocation to complete or time out waiting. Timeout values are in milliseconds.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Request

This endpoint expects an object.

timeoutMsintegerOptional<=600000

Response

Default Response

dataobject

timedOutboolean