Skip to main content
API reference sections

Schema

RunStatus

Where a run is. One canonical authority - the Run document - holds it (§7.1); runs.db never carries a second one.

Type object or object or object or object or object or object or object or object or object

Shape

One of 9 shapes:

  1. state: "created"

    The Run document exists; nothing has been asked to start.

    FieldTypeDescription
    staterequired"created"
  2. state: "starting"

    Admission, materialization and session creation are under way.

    FieldTypeDescription
    staterequired"starting"
  3. state: "running"

    The provider is up. attention and control are the markers §7.5 and §7.4 put on a running run instead of more states; both default so a header written before either existed still reads.

    FieldTypeDescription
    attentionAttentionSet

    Default []

    controlControlState

    Default {"holder":"orchestrator"}

    staterequired"running"
  4. state: "interrupted"

    A restart ended the attempt (D10). Never Failed; offers Resume.

    FieldTypeDescription
    prior_attemptrequiredPriorAttempt

    What recovery could prove about the attempt a restart interrupted (§7.6).

    staterequired"interrupted"
  5. state: "completed"

    An orchestrator turn completed the objective with nothing pending.

    FieldTypeDescription
    staterequired"completed"
  6. state: "failed"

    FieldTypeDescription
    stagerequiredFailureStage

    Why a start or a turn failed. A closed vocabulary - a stage, never a message - so a failure can be reported anywhere without carrying text.

    staterequired"failed"
  7. state: "cancelled"

    FieldTypeDescription
    staterequired"cancelled"
  8. state: "awaiting_review"

    Minted for M5 (UC14); no transition reaches it in M1.

    FieldTypeDescription
    staterequired"awaiting_review"
  9. state: "waiting_for_participant"

    Minted for M5 (UC13); no transition reaches it in M1.

    FieldTypeDescription
    staterequired"waiting_for_participant"
Example
{
  "state": "created"
}

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

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.