Request cancellation for a durable operation | BCTRL

import requests
url = "https://api.bctrl.ai/v1/operations/id/cancel"
payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "createdAt": "2024-06-10T15:00:00Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "runtime": "chrome_105",
  "runtimeId": "1c9d4f2e-8b3a-4f7a-9d2e-1a2b3c4d5e6f",
  "runtimeKind": "browser",
  "status": "cancelling",
  "workspaceId": "7e4f3d2c-1a9b-4c8d-8e7f-123456789abc",
  "cancelRequestedAt": "2024-06-10T15:45:30Z",
  "currentCall": "navigateToPage",
  "error": {
    "message": "Operation timed out after multiple attempts",
    "code": "TIMEOUT",
    "details": {
      "timeoutDuration": "30000ms",
      "attempt": 3
    }
  },
  "finishedAt": "2024-06-10T15:50:00Z",
  "lastHeartbeatAt": "2024-06-10T15:45:00Z",
  "progress": {
    "currentCall": "clickButton",
    "lastEventType": "step-completed",
    "message": "Clicking submit button",
    "step": 4,
    "totalSteps": 10
  },
  "result": {
    "mode": "fail-fast",
    "ok": true,
    "runtime": "chrome_105",
    "steps": [
      {
        "binding": {
          "alias": "mainPage",
          "id": "page-1234",
          "type": "page"
        },
        "call": "navigateToPage",
        "index": 0,
        "ok": true,
        "resolved": {
          "call": "navigateToPage",
          "contextId": "ctx-5678",
          "handleId": "handle-9012",
          "method": "goto",
          "pageId": "page-1234",
          "ref": "ref-3456",
          "sessionId": "session-7890",
          "target": "https://example.com/dashboard"
        }
      }
    ]
  },
  "startedAt": "2024-06-10T15:00:05Z"
}

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Response

Default Response

createdAtstring

idstringformat: "uuid"

runtimestringformat: "^[A-Za-z][A-Za-z0-9_-]{0,63}$"

runtimeIdstringformat: "uuid"

runtimeKindenum

Allowed values:

statusenum

workspaceIdstringformat: "uuid"

cancelRequestedAtstring or null

currentCallstring or null

errorobject or null

finishedAtstring or null

lastHeartbeatAtstring or null

progressobject or null

resultobject or null

startedAtstring or null