crouter

Runs

Starting a run, reading its status, trace and outcome, and parsing a result against a schema.

Exports of @crouter/sdk, read from the TypeScript compiler at build time. Types re-exported from @crouter/api are documented with that package.

RunActivity

type declared in resources/runs.ts

RunObject.activity while the run is running.

{ phase: 'starting' | 'thinking' | 'writing' | 'between_turns'; } | { phase: 'tool'; tool: { name: string; summary: string | null; }; }

RunDeleteResult

interface declared in resources/runs.ts

Prop

Type

RunObject

interface declared in resources/runs.ts

Prop

Type

RunParsedOutcome

type declared in resources/runs.ts

A settled runs.parse run: the run outcome plus output_parsed, typed to the schema and non-null exactly when kind is result.

((({ node_id: import("@crouter/api").NodeIdDTO; revision: number; settled_at: import("@crouter/api").IsoTime; final_report: string | null; structured_result: unknown | null; detail: import("@crouter/api").NodeOutcomeDetailV1 | null; } & { kind: 'failure'; reason: 'declined'; declined: import("@crouter/api").DeclinedResultDTO | null; details: import("@crouter/api").DeclinedResultDTO | null; }) | ({ node_id: import("@crouter/api").NodeIdDTO; revision: number; settled_at: import("@crouter/api").IsoTime; final_report: string | null; structured_result: unknown | null; detail: import("@crouter/api").NodeOutcomeDetailV1 | null; } & { kind: 'failure'; reason: 'canceled' | 'deadline_exceeded'; declined: null; }) | ({ node_id: import("@crouter/api").NodeIdDTO; revision: number; settled_at: import("@crouter/api").IsoTime; final_report: string | null; structured_result: unknown | null; detail: import("@crouter/api").NodeOutcomeDetailV1 | null; } & { kind: 'failure'; reason: 'runtime_error'; declined: null; details: { crouter_reason: string; }; })) & { output_parsed: null; }) | ({ node_id: import("@crouter/api").NodeIdDTO; revision: number; settled_at: import("@crouter/api").IsoTime; final_report: string | null; structured_result: unknown | null; detail: import("@crouter/api").NodeOutcomeDetailV1 | null; } & { kind: 'result'; reason: 'finalized'; declined: null; } & { output_parsed: T; })

RunParseOptions

interface declared in resources/runs.ts

Prop

Type

RunParseParams

type declared in resources/runs.ts

runs.parse params: runs.start's, with output_schema required.

Prop

Type

RunStartParams

interface declared in resources/runs.ts

Prop

Type

RunStartResult

interface declared in resources/runs.ts

Prop

Type

RunStatus

type declared in resources/runs.ts

"idle" | "running" | "settled" | "waiting_on_user"

RunTrace

type declared in resources/runs.ts

runs.trace in its rendered form; message content narrows on type and role fields on role.

Prop

Type

On this page