CancelRunResponse

POST /v1/runs/{run}/cancel: the header after the cancellation was asked for. During a turn the run is still Running until the provider answers; the stream carries the end.

Type object

Shape

Field	Type	Description
headerrequired	RunHeader	What the Run document carries (D14). There is no conversion to or from [`crate::AttemptState`], and these two doctests keep it that way: the day someone writes the `From`, they fail. `compile_fail use koru_delegate_core::{AttemptState, RunHeader}; fn sync_side(state: AttemptState) -> RunHeader { state.into() }` `compile_fail use koru_delegate_core::{AttemptState, RunHeader}; fn execution_side(header: RunHeader) -> AttemptState { header.into() }`

Example

{
  "header": {
    "run": "00000000-0000-4000-8000-000000000000",
    "created_at_ms": 0,
    "requested_by": {
      "profile": "00000000-0000-4000-8000-000000000000",
      "kind": "person"
    },
    "objective": "string",
    "agent": {
      "kind": "built_in",
      "value": "string"
    },
    "requested_model": "string",
    "scope": {
      "kind": "none"
    },
    "context": [
      {
        "workspace": "00000000-0000-4000-8000-000000000000",
        "document": "00000000-0000-4000-8000-000000000000",
        "version": "00000000-0000-4000-8000-000000000000",
        "kind": "document"
      }
    ],
    "grants": [],
    "status": {
      "state": "created"
    },
    "failure_reason": "capability_not_negotiated",
    "environment": {
      "device": "string",
      "kind": "local_device"
    },
    "artifacts": [],
    "economics": {
      "orchestrator_turns": 0,
      "human_turns": 0,
      "turns_with_usage": 0,
      "input": {
        "known": 0,
        "unavailable_turns": 0
      },
      "output": {
        "known": 0,
        "unavailable_turns": 0
      },
      "cached_input": {
        "known": 0,
        "unavailable_turns": 0
      },
      "tool_calls": 0,
      "interventions": 0,
      "elapsed_ms": null,
      "models": [],
      "complete": false
    },
    "rating": {
      "rating": "good",
      "note": "string",
      "rated_by": {
        "profile": "00000000-0000-4000-8000-000000000000",
        "kind": "person"
      },
      "rated_at_ms": 0
    },
    "origin": {
      "origin": "manual"
    }
  }
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Used by

POST/v1/runs/{run}/cancel
End the run

Generated from contract version 1. Last updated November 12, 2026.