Cancel Invocation | BCTRL Docs

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

1	{
2	"artifactCount": 3,
3	"createdAt": "2024-06-10T14:00:00Z",
4	"entryCall": "initializeWorkflow",
5	"executionMode": "durable",
6	"id": "123e4567-e89b-12d3-a456-426614174000",
7	"runId": "7f9c2d3e-4b5a-6789-cdef-0123456789ab",
8	"runtimeId": "9a7b3c2d-4e5f-6789-abcd-ef0123456789",
9	"runtimeKind": "browser",
10	"sequenceNo": 42,
11	"spaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
12	"status": "cancelling",
13	"stepCount": 10,
14	"cancelRequestedAt": "2024-06-10T15:22:30Z",
15	"connector": "github-actions",
16	"correlationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
17	"durationMs": 452300,
18	"error": {
19	"message": "Invocation timed out during fetchData step",
20	"code": "TIMEOUT",
21	"details": {
22	"timeoutDuration": "5m",
23	"step": "fetchData"
24	}
25	},
26	"finishedAt": null,
27	"lastHeartbeatAt": "2024-06-10T15:20:00Z",
28	"metadata": {
29	"environment": "production",
30	"triggeredBy": "[email protected]"
31	},
32	"progress": {
33	"currentCall": "processData",
34	"lastEventType": "step_completed",
35	"message": "Processing data batch 4 of 10",
36	"step": 4,
37	"totalSteps": 10
38	},
39	"request": {
40	"runtimeId": "9a7b3c2d-4e5f-6789-abcd-ef0123456789",
41	"steps": [
42	{
43	"call": "loadData",
44	"args": [
45	"input.csv",
46	true
47	],
48	"bind": "dataLoader",
49	"options": {
50	"dryRun": false,
51	"timeoutMs": 300000
52	},
53	"ref": "step1"
54	}
55	],
56	"idempotencyKey": "invocation-20240610-142200",
57	"mode": "fail-fast"
58	},
59	"result": {
60	"mode": "fail-fast",
61	"ok": false,
62	"runtimeId": "9a7b3c2d-4e5f-6789-abcd-ef0123456789",
63	"steps": [
64	{
65	"binding": {
66	"alias": "mainPage",
67	"id": "page-001",
68	"type": "page"
69	},
70	"call": "loadData",
71	"index": 0,
72	"ok": true,
73	"resolved": {
74	"call": "loadData",
75	"contextId": "ctx-123",
76	"handleId": "handle-456",
77	"method": "GET",
78	"pageId": "page-001",
79	"ref": "step1",
80	"runtimeId": "9a7b3c2d-4e5f-6789-abcd-ef0123456789",
81	"target": "https://data-source.example.com"
82	}
83	}
84	]
85	},
86	"startedAt": "2024-06-10T14:00:00Z"
87	}

Request cancellation for a durable invocation. Use this to stop agent work that should no longer continue.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Response

Default Response

artifactCountinteger0-9007199254740991

createdAtstring

entryCallstring>=1 character

executionModeenum

Allowed values:

idstringformat: "uuid"

runIdstringformat: "uuid"

runtimeIdstringformat: "uuid"

runtimeKindenum

Allowed values:

sequenceNointeger<=9007199254740991

spaceIdstringformat: "uuid"

statusenum

stepCountinteger<=9007199254740991

cancelRequestedAtstring or null

connectorstring or null>=1 character

correlationIdstring or null

durationMsinteger or null0-9007199254740991

errorobject or null

finishedAtstring or null

lastHeartbeatAtstring or null

metadatamap from strings to any or null

progressobject or null

requestobject or null

resultobject or null

startedAtstring or null