Cancel Invocation | BCTRL Docs

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

{
  "action": "act",
  "createdAt": "2024-06-01T12:00:00Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "runId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "runtimeId": "1c9e6679-7425-40de-944b-e07fc1f90ae7",
  "status": "cancelled",
  "durationMs": 3500,
  "error": {
    "code": "invocation.cancelled",
    "message": "Invocation was cancelled before completion.",
    "details": {
      "cancelledBy": "user_request",
      "reason": "User requested cancellation due to updated input parameters."
    }
  },
  "finishedAt": "2024-06-01T12:00:03Z",
  "output": null,
  "startedAt": "2024-06-01T11:59:57Z"
}

Request cancellation for one durable invocation on its live runtime.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

runtimeIdstringRequired

invocationIdstringRequired

Response

actionenum

createdAtstring

idstringformat: "uuid"

runIdstringformat: "uuid"

runtimeIdstringformat: "uuid"

statusenum

durationMsinteger or null0-9007199254740991

errorobject or null

finishedAtstring or null

outputany

Any valid JSON value: object, array, string, number, boolean, or null.

startedAtstring or null

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error