Runs

Cancel run

Requests cancellation for a REST API run. Accepted or queued runs become terminal canceled immediately; running runs are marked cancelRequested for the execution layer to stop at the next safe point.

post/api/v1/runs/{run_id}/cancel

Request

  • Base URL: https://api.studio.kaitoi.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.studio.kaitoi.io/api/v1/runs/{run_id}/cancel
  • Auth: HTTP bearer

Path parameters

run_idstring required

Headers

authorizationstring nullable

Response

Run record after the cancellation request.

idstring required
sourceType'project' | 'inline_graph'
projectIdstring nullable
projectVersioninteger nullable
status'accepted' | 'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
cancelRequestedboolean
targetNodeIdsstring[]
externalIdstring nullable
externalUserIdstring nullable
externalWorkspaceIdstring nullable
outputsobject
errorobject nullable
creditsUsedinteger nullable

Credits charged by this run. Null while the run is active, or when a terminal run could not produce a reliable accounting summary.

creditsUsedMicrocreditsstring nullable

Exact run charge in millionths of one credit.

executionTimeMsinteger nullable
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "createdAt": "2026-01-01T00:00:00Z",
  "creditsUsed": 12,
  "executionTimeMs": 2143,
  "id": "run_abc123",
  "outputs": {
    "outputImage": {
      "contentType": "image/png",
      "downloadUrl": "https://files.example/d/2f8f8c5df80e4f76a5b7d1bbd6fae0ab.png?sig=...",
      "fileId": "2f8f8c5df80e4f76a5b7d1bbd6fae0ab.png",
      "filename": "random_image.png",
      "previewUrl": "https://files.example/p/2f8f8c5df80e4f76a5b7d1bbd6fae0ab.png?sig=...",
      "sizeBytes": 482931,
      "type": "file"
    }
  },
  "sourceType": "inline_graph",
  "spend": {
    "byChargeType": {
      "provider": 12
    },
    "byNode": [
      {
        "billedRuns": 1,
        "credits": 12,
        "nodeId": "image",
        "nodeTitle": "Generate Image",
        "nodeType": "builtin/image/generate"
      }
    ],
    "byProvider": {
      "fal": 12
    },
    "totalCredits": 12
  },
  "status": "succeeded",
  "targetNodeIds": [
    "image"
  ],
  "updatedAt": "2026-01-01T00:00:03Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.