no skills preloaded.

• kanban::ticket::getkanban0.1.23schema

  Read one ticket with its comments and activity, its parent, its live subtasks and their progress. The id accepts the internal uuid or the human-readable key.

  request

  • idstring*required

    Ticket uuid or human-readable key (KAN-1, case-insensitive).

  response

  • activityobject[]

    • actorstring*required
    • atstring*required
    • changesobject[]

      • fieldstring*required
      • fromunknown*required
      • tounknown*required
    • comment_idstring
    • idstring*required
    • seqinteger· uint64*requiredmin 0
    • ticket_idstring*required
    • typestring*required

      ticket.created | ticket.updated | ticket.moved | ticket.deleted | ticket.restored | comment.created

  • assigneestring

    Agent profile id.

  • childrenobject[]*required

    Live subtasks by ticket number.

    • assigneestring
    • deleted_atstring
    • idstring*required
    • keystring*required
    • prioritystring*required
    • project_idstring
    • release_idstring
    • statusstring*required
    • titlestring*required
  • commentsobject[]

    • authorstring*required

      Agent profile id, or `user`.

    • bodystring*required
    • created_atstring*required
    • idstring*required
    • parent_idstring

      Set for a reply; replies stay one level deep.

    • ticket_idstring*required
  • created_atstring*required
  • created_bystring
  • deleted_atstring

    Set when soft-deleted; the row stays on disk.

  • descriptionstring
  • idstring*required

    Internal uuid.

  • keystring*required

    Human-readable id, e.g. KAN-1.

  • labelsstring[]
  • orderinteger· uint64min 0

    Position inside its column.

  • parentany of

    The parent, deleted or not; `null` for a ticket that is not a subtask.

    any of (2)

    variant 1

    • assigneestring
    • deleted_atstring
    • idstring*required
    • keystring*required
    • prioritystring*required
    • project_idstring
    • release_idstring
    • statusstring*required
    • titlestring*required

    variant 2

    valuenull
  • parent_idstring

    Uuid of the parent ticket. One level deep: a parent has no parent.

  • prioritystring*required
  • progressobject*required

    Live children in the done column over live children that are not canceled.

    • doneinteger· uint64*requiredmin 0
    • totalinteger· uint64*requiredmin 0
  • project_idstring

    Uuid of the project (several tickets, independent of the release).

  • release_idstring

    Uuid of the release.

  • statusstring*required

    Column id.

  • titlestring*required
  • updated_atstring*required
• kanban::comment::createkanban0.1.23schema

  Comment on a ticket, or reply to a comment by passing parent_id. Returns the new comment and the ticket (only its compact row with compact).

  request

  • authorstring

    Agent profile id, or `user`. Defaults to `user`.

  • bodystring*required

    Comment body. Markdown is rendered in the console.

  • compactboolean

    Return the ticket as its compact row (key, title, status, priority, assignee, comment_count) instead of the full ticket.

  • parent_idstring

    Comment id to reply to; replies stay one level deep.

  • ticket_idstring*required

    Ticket uuid or human-readable key (KAN-1, case-insensitive).

  response

  • commentobject*required

    • authorstring*required

      Agent profile id, or `user`.

    • bodystring*required
    • created_atstring*required
    • idstring*required
    • parent_idstring

      Set for a reply; replies stay one level deep.

    • ticket_idstring*required
  • ticketany of*required

    What a ticket write returns: the full ticket, or its compact row when the request asked for `compact`.

    any of (2)

    variant 1

    • activityobject[]

      … expand 8 nestedcollapse

      • actorstring*required
      • atstring*required
      • changesobject[]

        … expand 3 nestedcollapse

        • fieldstring*required
        • fromunknown*required
        • tounknown*required
      • comment_idstring
      • idstring*required
      • seqinteger· uint64*requiredmin 0
      • ticket_idstring*required
      • typestring*required

        ticket.created | ticket.updated | ticket.moved | ticket.deleted | ticket.restored | comment.created

    • assigneestring

      Agent profile id.

    • childrenobject[]*required

      Live subtasks by ticket number.

      … expand 9 nestedcollapse

      • assigneestring
      • deleted_atstring
      • idstring*required
      • keystring*required
      • prioritystring*required
      • project_idstring
      • release_idstring
      • statusstring*required
      • titlestring*required
    • commentsobject[]

      … expand 6 nestedcollapse

      • authorstring*required

        Agent profile id, or `user`.

      • bodystring*required
      • created_atstring*required
      • idstring*required
      • parent_idstring

        Set for a reply; replies stay one level deep.

      • ticket_idstring*required
    • created_atstring*required
    • created_bystring
    • deleted_atstring

      Set when soft-deleted; the row stays on disk.

    • descriptionstring
    • idstring*required

      Internal uuid.

    • keystring*required

      Human-readable id, e.g. KAN-1.

    • labelsstring[]
    • orderinteger· uint64min 0

      Position inside its column.

    • parentany of

      The parent, deleted or not; `null` for a ticket that is not a subtask.

      … expand 2 nestedcollapse

      any of (2)

      variant 1

      • assigneestring
      • deleted_atstring
      • idstring*required
      • keystring*required
      • prioritystring*required
      • project_idstring
      • release_idstring
      • statusstring*required
      • titlestring*required

      variant 2

      valuenull
    • parent_idstring

      Uuid of the parent ticket. One level deep: a parent has no parent.

    • prioritystring*required
    • progressobject*required

      Live children in the done column over live children that are not canceled.

      … expand 2 nestedcollapse

      • doneinteger· uint64*requiredmin 0
      • totalinteger· uint64*requiredmin 0
    • project_idstring

      Uuid of the project (several tickets, independent of the release).

    • release_idstring

      Uuid of the release.

    • statusstring*required

      Column id.

    • titlestring*required
    • updated_atstring*required

    variant 2

    • assigneestring
    • comment_countinteger· uint64*requiredmin 0
    • keystring*required
    • prioritystring*required
    • statusstring*required
    • titlestring*required
• harness::spawnharness1.8.55schema

  Spawn a sub-agent in a child session (never a trigger target) and return { child_session_id, child_turn_id } immediately; the child's outcome reaches you only through whatever destination its task names. Check `harness::status` for child health; children are leaves unless options.orchestrator is true.

  request

  • agentstring

    Directory agent profile id (`directory::agents::*`) supplying the child's prompt, skills, model, and display; refused with `options.system_prompt`. Omitted, an in-turn spawn continues the parent turn's profile (name `options.system_prompt` for a child that needs a different identity).

  • displayany of

    Display-only name/icon/color for the child session; never affects ids, policy, or routing.

    any of (2)

    variant 1

    • colorany of

      … expand 2 nestedcollapse

      any of (2)

      variant 1

      valuestringenum: neutral, blue, purple, teal, green, amber, …

      variant 2

      valuenull
    • iconany of

      … expand 2 nestedcollapse

      any of (2)

      variant 1

      valuestringenum: agent, code, search, terminal, database, test, …

      variant 2

      valuenull
    • namestring*required1…48 chars

      Short functional name such as `Frontend`, 1-48 characters after trimming.

    variant 2

    valuenull
  • modelstring
  • optionsany of

    any of (2)

    variant 1

    • filesystem_rootstring

      Absolute filesystem root for the child turn; omit to inherit the parent's.

    • functionsany of

      Dispatch policy for the child, intersected with the parent's (narrow, never escalate).

      … expand 2 nestedcollapse

      any of (2)

      variant 1

      • allowstring[]
      • denystring[]
      • exposeall of

        … expand 1 nestedcollapse

        all of (1)

        variant 1

        valuestringenum: agent_trigger, native

      variant 2

      valuenull
    • max_childreninteger· uint32min 0

      Fan-out guard for the child's own spawns.

    • max_output_tokensinteger· uint64min 0

      Inherits the parent's ceiling unless explicitly narrowed/overridden.

    • max_turnsinteger· uint32min 0

      Turn cap for the child, capped at the parent's remaining budget; omit unless required (small values strand the child).

    • max_validation_retriesinteger· uint32min 0

      Override of the child's validation-retry budget.

    • orchestratorboolean

      Let the child spawn, send, and register triggers (still capped by the parent's policy); default false makes it a leaf.

    • outputany of

      The child's deliverable: text / json / json+schema.

      … expand 2 nestedcollapse

      any of (2)

      variant 1

      one of (2)

      variant 1

      • typestring*requiredenum: text

      variant 2

      • schemaunknown
      • typestring*requiredenum: json

      variant 2

      valuenull
    • skillsstring[]

      Exact skill ids advertised to the child; omitted or empty means all (a reused child inherits when omitted).

    • system_promptstring
    • system_prompt_strategyall of

      How `system_prompt` combines with the built-in prompt.

      … expand 1 nestedcollapse

      all of (1)

      variant 1

      one of (3)

      variant 1

      valuestringenum: override

      variant 2

      valuestringenum: enrich

      variant 3

      valuestringenum: disabled
    • thinking_levelany of

      … expand 2 nestedcollapse

      any of (2)

      variant 1

      one of (2)

      variant 1

      valuestringenum: minimal, low, medium, high, xhigh

      variant 2

      valuestringenum: off

      variant 2

      valuenull

    variant 2

    valuenull
  • parent_session_idstring

    Display-only parent for the console tree when there is no live parent turn; grants no policy inheritance.

  • providerstring
  • session_idstring

    Session id to spawn into, created if absent; an existing id may be reused only inside the caller's own tree.

  • taskstring*required

    The child's self-contained goal, its opening user message; name every required resource selector literally (the child cannot infer them).

  response

  • child_session_idstring*required
  • child_turn_idstring*required
  • reusedboolean

    The named session already existed and was reused — its prior transcript and parent linkage were retained (only possible with an explicit `session_id`).

• harness::statusharness1.8.55schema

  Read a session's current turn. Returns a lean summary by default; pass verbose: true for the full runtime report and untruncated result.

  request

  • session_idstring*required
  • verboseboolean

    Include the full runtime report and unmodified result.

  response

  any of (2)

  variant 1

  • armed_wakesobject[]

    WHAT the session is parked on, when `expects_wake`: each armed wake's watch and deadline, so "parked 12m on state operation_meta/status — never written" is readable from the outside instead of the session just looking quietly done.

    • configunknown
    • created_atinteger· int64*required
    • expires_atinteger· int64
    • subscription_idstring*required
    • trigger_typestring

      The registered trigger's type/config, read from the canonicalised registration request. Absent on records that predate it.

  • childrenobject[]*required

    • function_call_idstring*required
    • session_idstring*required
    • turn_idstring*required
  • contextany of

    The last generate step's context accounting (budget, categories, provider-exact usage once it lands) — what a UI meter should show instead of re-estimating the transcript. Verbose only; absent before the first generate.

    any of (2)

    variant 1

    • categoriesobject*required

      Where the request's tokens sit. Categories are assembly-time estimates; `hook_guidance` is the measured growth after assembly (pre-generate hook appends and orphan-repair patches), 0 when the request left assembly unchanged.

      … expand 6 nestedcollapse

      • hook_guidanceinteger· uint64min 0
      • messagesobject*required

        Estimated tokens of the assembled window's messages, by role.

        … expand 4 nestedcollapse

        • assistantinteger· uint64*requiredmin 0
        • custominteger· uint64*requiredmin 0
        • function_resultinteger· uint64*requiredmin 0
        • userinteger· uint64*requiredmin 0
      • overheadinteger· uint64*requiredmin 0

        Provider framing plus response_format / provider_options fields.

      • skillsinteger· uint64min 0

        Selected skill bodies contained in the system prompt.

      • system_promptinteger· uint64*requiredmin 0

        Final assembled system prompt excluding tokens attributed to `skills`: identity, per-step aids, and any compaction summary section.

      • toolsinteger· uint64*requiredmin 0

        Function schemas exposed to the model.

    • compactedboolean*required

      The context carries a conversation summary: compacted on this step, or anchored on an earlier compaction entry (a previous step, the console's `/compact`). The summary's tokens count in `system_prompt`.

    • effective_max_output_tokensinteger· uint64*requiredmin 0

      Output allocation `usable` was derived against.

    • estimatorstring

      Which estimator produced the numbers (`heuristic` until the context-manager resolves a real tokenizer). Absent when the context-manager predates the breakdown response.

    • freeinteger· uint64*requiredmin 0
    • modelstring*required
    • prefix_divergencesobject[]

      Already-sent rows this session's requests rewrote, newest last (at most [`MAX_PREFIX_DIVERGENCES`]), carried from step to step.

      … expand 9 nestedcollapse

      • cache_readinteger· uint64min 0

        `usage.cache_read` of the rewriting request: what the provider still reused.

      • call_idstring
      • causestring

        What rewrote the row, as far as the harness can tell: `prune` (context-manager pruned or reduced function results to fit the budget that step) or `system_prompt` (row 0: a compaction summary or a prompt change).

      • indexinteger· uint64min 0

        First row (0 = system prompt, then one per message) that differs from the session's previous request. Absent when only the provider's wire mapping changed.

      • prev_leninteger· uint64min 0

        Rows the previous request carried.

      • provider_notestring

        The provider's own wire-level finding, cause included, when it reported one (a final-message warning starting with [`PROVIDER_PREFIX_NOTE`]).

      • rolestring
      • stepinteger· uint64*requiredmin 0
      • turn_idstring*required
    • prompt_sections_fallbackstring

      Why no shared prefix went out: `disabled` (config), `no_stable_prefix` (empty identity prompt) or `prefix_rewritten` (a pre_generate hook replaced the prompt head; its prompt still wins, it just shares nothing).

    • prompt_surface_digeststring

      Identity of the shared prompt prefix this generation went out with (`sha256:` of the stable section) — present only when the request carried `system_sections`. A local identity, never a provider hit; `usage.cache_read` is the reuse signal.

    • providerstring
    • session_cost_usdnumber· double

      Running cost of the whole session in USD, accumulated across every generation step. `usage.cost_usd` is one step's bill — on providers with steep cache discounts the per-step number swings two orders of magnitude, so a chip showing it alone reads as a bouncing total.

    • session_idstring*required
    • stepinteger· uint64*requiredmin 0
    • summarized_head_tokensinteger· uint64min 0

      Size of the history that summary replaced.

    • timestampinteger· int64*required
    • totalinteger· uint64*requiredmin 0

      Final request estimate: categories plus post-assembly growth.

    • turn_idstring*required
    • usableinteger· uint64*requiredmin 0

      The input budget the window was fit into.

    • usageany of

      Actual provider usage for this generation, stamped after the terminal frame; absent when the provider returned none (or the generation never completed).

      … expand 2 nestedcollapse

      any of (2)

      variant 1

      • cache_readinteger· uint64min 0
      • cache_writeinteger· uint64min 0
      • cost_usdnumber· double
      • inputinteger· uint64min 0
      • outputinteger· uint64min 0
      • reasoninginteger· uint64min 0

      variant 2

      valuenull

    variant 2

    valuenull
  • depthinteger· uint32min 0
  • expects_wakeboolean

    The session owns an armed wake (a one-shot notify subscription): a completed turn here is NOT the run's outcome — a later turn in this session carries it. Mirrors the `terminal` flag on `harness::turn-completed` (`expects_wake == !terminal`). Pollers (e.g. workflow reconcile) must treat `completed && expects_wake` as still running.

  • max_transient_resumesinteger· uint32min 0
  • max_turnsinteger· uint32min 0
  • max_validation_retriesinteger· uint32min 0
  • partial_result_availableboolean
  • pending_function_callsstring[]
  • queuedobject[]

    Messages queued while a step streams, in arrival order; they land in the transcript when the stream ends.

    • entry_idstring*required

      Deterministic transcript entry id the drain appends under, so a redelivered drain is a no-op.

    • idstring*required
    • messageany of*required

      The canonical transcript message union. Untagged: the single-variant role tags disambiguate deserialization (assistant/function_result/custom are tried before user so their required fields gate the match).

      … expand 4 nestedcollapse

      any of (4)

      variant 1

      • contentone of[]*required

        … expand 7 nestedcollapse

        one of (7)

        variant 1

        • textstring*required
        • typestring*requiredenum: text

        variant 2

        • attachment_idstring

          Optional link to the stored original of this inline image (`session::put-attachment`, resolvable with `session::get-attachment`). Lets readers ask `session::messages { include_image_data: false }` and fetch the bytes lazily instead of receiving them inline. Persisted verbatim on the transcript; model-bound consumers never see it (see [`ContentBlock::strip_files`]). Omitted on the wire when absent so legacy transcripts stay byte-identical.

        • datastring*required
        • mimestring*required
        • typestring*requiredenum: image

        variant 3

        • attachment_idstring*required
        • mimestring*required
        • namestring*required
        • sizeinteger· uint64*requiredmin 0
        • typestring*requiredenum: file

        variant 4

        • signaturestring
        • textstring*required
        • typestring*requiredenum: thinking

        variant 5

        • datastring*required
        • typestring*requiredenum: redacted_thinking

        variant 6

        • argumentsunknown*required
        • function_idstring*required
        • idstring*required
        • typestring*requiredenum: function_call

        variant 7

        • contentunknown[]*required
        • function_call_idstring*required
        • is_errorboolean
        • typestring*requiredenum: function_result
      • error_kindany of

        … expand 2 nestedcollapse

        any of (2)

        variant 1

        valuestringenum: auth_expired, rate_limited, context_overflow, transient, permanent

        variant 2

        valuenull
      • error_messagestring
      • modelstring*required
      • native_stop_reasonstring
      • providerstring*required
      • rolestring*requiredenum: assistant
      • stop_reasonstring*requiredenum: end, length, function_call, aborted, error
      • timestampinteger· int64*required
      • usageany of

        … expand 2 nestedcollapse

        any of (2)

        variant 1

        • cache_readinteger· uint64min 0
        • cache_writeinteger· uint64min 0
        • cost_usdnumber· double
        • inputinteger· uint64min 0
        • outputinteger· uint64min 0
        • reasoninginteger· uint64min 0

        variant 2

        valuenull
      • warningsstring[]

      variant 2

      • contentone of[]*required

        … expand 7 nestedcollapse

        one of (7)

        variant 1

        • textstring*required
        • typestring*requiredenum: text

        variant 2

        • attachment_idstring

          Optional link to the stored original of this inline image (`session::put-attachment`, resolvable with `session::get-attachment`). Lets readers ask `session::messages { include_image_data: false }` and fetch the bytes lazily instead of receiving them inline. Persisted verbatim on the transcript; model-bound consumers never see it (see [`ContentBlock::strip_files`]). Omitted on the wire when absent so legacy transcripts stay byte-identical.

        • datastring*required
        • mimestring*required
        • typestring*requiredenum: image

        variant 3

        • attachment_idstring*required
        • mimestring*required
        • namestring*required
        • sizeinteger· uint64*requiredmin 0
        • typestring*requiredenum: file

        variant 4

        • signaturestring
        • textstring*required
        • typestring*requiredenum: thinking

        variant 5

        • datastring*required
        • typestring*requiredenum: redacted_thinking

        variant 6

        • argumentsunknown*required
        • function_idstring*required
        • idstring*required
        • typestring*requiredenum: function_call

        variant 7

        • contentunknown[]*required
        • function_call_idstring*required
        • is_errorboolean
        • typestring*requiredenum: function_result
      • detailsunknown*required
      • function_call_idstring*required
      • function_idstring*required
      • is_errorboolean*required
      • rolestring*requiredenum: function_result
      • timestampinteger· int64*required

      variant 3

      • contentone of[]*required

        … expand 7 nestedcollapse

        one of (7)

        variant 1

        • textstring*required
        • typestring*requiredenum: text

        variant 2

        • attachment_idstring

          Optional link to the stored original of this inline image (`session::put-attachment`, resolvable with `session::get-attachment`). Lets readers ask `session::messages { include_image_data: false }` and fetch the bytes lazily instead of receiving them inline. Persisted verbatim on the transcript; model-bound consumers never see it (see [`ContentBlock::strip_files`]). Omitted on the wire when absent so legacy transcripts stay byte-identical.

        • datastring*required
        • mimestring*required
        • typestring*requiredenum: image

        variant 3

        • attachment_idstring*required
        • mimestring*required
        • namestring*required
        • sizeinteger· uint64*requiredmin 0
        • typestring*requiredenum: file

        variant 4

        • signaturestring
        • textstring*required
        • typestring*requiredenum: thinking

        variant 5

        • datastring*required
        • typestring*requiredenum: redacted_thinking

        variant 6

        • argumentsunknown*required
        • function_idstring*required
        • idstring*required
        • typestring*requiredenum: function_call

        variant 7

        • contentunknown[]*required
        • function_call_idstring*required
        • is_errorboolean
        • typestring*requiredenum: function_result
      • custom_typestring*required
      • detailsunknown
      • displaystring
      • rolestring*requiredenum: custom
      • timestampinteger· int64*required

      variant 4

      • contentone of[]*required

        … expand 7 nestedcollapse

        one of (7)

        variant 1

        • textstring*required
        • typestring*requiredenum: text

        variant 2

        • attachment_idstring

          Optional link to the stored original of this inline image (`session::put-attachment`, resolvable with `session::get-attachment`). Lets readers ask `session::messages { include_image_data: false }` and fetch the bytes lazily instead of receiving them inline. Persisted verbatim on the transcript; model-bound consumers never see it (see [`ContentBlock::strip_files`]). Omitted on the wire when absent so legacy transcripts stay byte-identical.

        • datastring*required
        • mimestring*required
        • typestring*requiredenum: image

        variant 3

        • attachment_idstring*required
        • mimestring*required
        • namestring*required
        • sizeinteger· uint64*requiredmin 0
        • typestring*requiredenum: file

        variant 4

        • signaturestring
        • textstring*required
        • typestring*requiredenum: thinking

        variant 5

        • datastring*required
        • typestring*requiredenum: redacted_thinking

        variant 6

        • argumentsunknown*required
        • function_idstring*required
        • idstring*required
        • typestring*requiredenum: function_call

        variant 7

        • contentunknown[]*required
        • function_call_idstring*required
        • is_errorboolean
        • typestring*requiredenum: function_result
      • rolestring*requiredenum: user
      • timestampinteger· int64*required
    • originunknown
    • queued_atinteger· int64*required
    • session_idstring*required
  • resultunknown
  • result_errorstring
  • session_idstring*required
  • statusstring*requiredenum: running, awaiting_functions, completed, cancelled, failed

    The coarse, harness-internal turn lifecycle (harness.md § API Reference). Finer-grained than the session's `status`, which the loop derives from it.

  • stepinteger· uint64*requiredmin 0
  • stop_reasonstring

    Why a `completed` turn stopped when the model did not end it itself (`max_turns`). Present in the lean report too: a poller that reads `completed` with no error must still be able to tell an exhausted budget from a finished task.

  • transient_resumesinteger· uint32min 0
  • turn_countinteger· uint32*requiredmin 0
  • turn_idstring
  • validation_retriesinteger· uint32min 0

  variant 2

  valuenull
• harness::stopharness1.8.55schema

  Request cancellation of an in-flight turn (cascades to spawned children).

  request

  • session_idstring*required
  • turn_idstring

    Omit to stop the current turn.

  response

  • stoppingboolean*required
• engine::register_triggerunknown
• state::liststate0.22.19schema

  List every value stored in a state scope

  request

  • scopestring*required

    Namespace whose keys should be listed as a group.

  response

  valuestring
• state::compare-and-setstate0.22.19schema

  Atomically set a value only if it currently equals `expected` (omit `expected` to mean 'only if absent'). Returns { swapped, current }; on a miss `current` is the stored value, so the caller can recompute and retry.

  request

  • expectedunknown

    The value the caller believes is there. Omit to mean "expect absent" — the set-if-absent form.

  • keystring*required
  • scopestring*required
  • valueunknown*required

  response

  • currentunknown

    What is actually stored, when the swap did not happen.

  • swappedboolean*required