Skip to main content
API reference sections

Schema

TimelineRef

Something a step touched, by id.

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

Shape

One of 12 shapes:

  1. ref: "attempt"

    FieldTypeDescription
    attemptrequiredRunAttemptId
    refrequired"attempt"
  2. ref: "turn"

    FieldTypeDescription
    turnrequiredAgentTurnId
    refrequired"turn"
  3. ref: "actor"

    FieldTypeDescription
    actorrequiredActorRef
    refrequired"actor"
  4. ref: "document"

    A document as the run received it - the pin, so a later deletion is rendered as the target's state (D46), never as a missing step.

    FieldTypeDescription
    documentrequiredDocumentId

    DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.

    versionrequiredDocumentVersionId

    DocumentVersionId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.

    refrequired"document"
  5. ref: "blob"

    FieldTypeDescription
    blobrequiredBlobHash

    <algorithm>:<digest> - b3:<64 hex>.

    The algorithm is in the value because a hash that does not say what it is cannot be migrated: adopting a second one has to be additive, or every document already written is orphaned.

    refrequired"blob"
  6. ref: "artifact"

    FieldTypeDescription
    artifactrequiredArtifactVersionId
    refrequired"artifact"
  7. ref: "device"

    FieldTypeDescription
    devicerequiredstring
    refrequired"device"
  8. ref: "approval"

    FieldTypeDescription
    approvalrequiredApprovalId
    refrequired"approval"
  9. ref: "attachment"

    FieldTypeDescription
    attachmentrequiredAttachmentId
    refrequired"attachment"
  10. ref: "session"

    FieldTypeDescription
    sessionrequiredTerminalSessionId
    refrequired"session"
  11. ref: "model"

    FieldTypeDescription
    modelrequiredModelRef
    refrequired"model"
  12. ref: "schedule"

    The schedule authority that created this run. The claimed revision and occurrence ride with it so a later template edit cannot rewrite history.

    FieldTypeDescription
    schedulerequiredScheduleId
    occurrence_msrequiredinteger (int64)
    revisionrequiredinteger (uint32, >= 0)
    refrequired"schedule"
Example
{
  "attempt": "00000000-0000-4000-8000-000000000000",
  "ref": "attempt"
}

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.