Module types
Expand description
Shared request/response types for the ZeroClaw RPC + gateway API surface.
Re-exports§
pub use crate::cron::CronJob;pub use crate::cron::CronJobPatch;pub use crate::cron::CronRun;pub use crate::cron::DeliveryConfig;pub use crate::cron::Schedule;pub use crate::doctor::DiagResult;pub use crate::doctor::Severity as DoctorSeverity;pub use crate::rpc::session::SessionOverrides;pub use crate::skills::frontmatter::SkillFrontmatter;pub use crate::quickstart::AppliedAgent;pub use crate::quickstart::FieldDescriptor;pub use crate::quickstart::FieldSection;pub use crate::quickstart::QuickstartError;pub use crate::quickstart::QuickstartStep;pub use crate::quickstart::Surface;
Structs§
- Agent
Delete Params - Agent
Delete Preview Result - Agent
Delete Result - Agent
Entry - Agent
Skill Entry - Agent
Skills Result - Agent
Status Entry - Agents
List Result - Agents
Status Result - Builder
Submission - Complete builder submission consumed by the shared Quickstart apply path.
- Catalog
Model Provider - Consolidates gateway
CatalogModelProvider. - Catalog
Models Params - Catalog
Models Result - Consolidates gateway
ModelsResponse. - Catalog
Response - Consolidates gateway
CatalogResponse. - Command
Descriptor - Command identity and accepted tokens advertised to an RPC client.
- Config
Delete Params - Config
Delete Result - Config
Field Entry - Config
GetParams - Config
GetProp Result - Returned when
config/getis called with a specificprop. - Config
List Params - Config
List Result - Config
MapKey Create Params - Config
MapKey Create Result - Config
MapKey Delete Params - Config
MapKey Delete Result - Config
MapKey Rename Params - Config
MapKey Rename Result - Config
MapKeys Params - Config
MapKeys Result - Config
Reload Result - Config
Resolve Alias Source Params - Config
Resolve Alias Source Result - Config
Section Entry - A config section entry for the dashboard sidebar / TUI section list.
- Config
Sections Result - Response for
config/sections. - Config
SetMany Params - An ordered batch of
config/setentries committed as one unit: every entry is staged on a single working copy in order (a later entry for the same prop wins), and the result is saved and installed once, or not at all. Must contain at least one entry and at most the dispatcher’s batch cap (256); either bound violated isINVALID_PARAMS. - Config
SetMany Result - Config
SetParams - Value is polymorphic: a JSON string passes through as-is (backward
compat); any other JSON type is coerced via
coerce_for_set_prop. - Config
SetResult - Config
Status Result - Config readiness status for the dashboard/TUI.
- Config
Template Entry - Owned wire representation of a
zeroclaw_config::traits::MapKeySection. The upstream type uses&'static strfields that can’t round-trip throughDeserialize, so this owned copy serves as the wire format. - Config
Templates Result - Config
Validate Result - Cost
Query Params - Params for
cost/query. Consolidates gatewayCostQuery. - Cost
Summary - Cost summary for reporting.
- Cron
AddParams - Params for
cron/add. Consolidates gatewayCronAddBody. - Cron
Delete Result - Cron
IdParams - Cron
List Result - Cron
Patch Params - Params for
cron/patch. Consolidates gatewayCronPatchBody. - Cron
Runs Params - Cron
Runs Result - Cron
Trigger Result - Doctor
RunResult - Doctor
Summary - Dropped
Skill Entry - A candidate skill the audited resolver dropped (security audit failed, unauditable, or manifest parse error)
- Events
History Result events/history: recent observer frames, oldest first.- File
Attach Params - File
Attach Result - File
Entry - A single file entry in a
file/attachrequest. Eitherpath(daemon reads from local disk — Unix socket only) ordata_b64(client sends base64-encoded bytes) must be present. - File
Entry Result - Result for a single file in a
file/attachresponse. - File
Upload Begin Params - Parameters for
file/upload/begin: announce one upload for a session. - File
Upload Begin Result - File
Upload Chunk Params - Parameters for
file/upload/chunk. Chunks arrive in order:offsetmust equal the bytes received so far. Resending an already-accepted chunk with identical bytes is acknowledged without change. - File
Upload Chunk Result - File
Upload Commit Params - Parameters for
file/upload/commit. The result is the sameFileEntryResultthatfile/attachreturns for one file. - Initialize
Params - Initialize
Result - Logs
GetParams logs/getparams — fetch a single event by id.- Logs
GetResult logs/getresult.eventis the fullLogEventpayload (attributes, attribution map, span ids, …) that the Logs pane only renders inside the detail modal — list rows store preview-only data.- Logs
Query Params - Logs
Query Result - Logs
Subscribe Result - Every notification of the subscription carries
subscription_idand itsseq.seqhere is the newest sequence number at subscribe time. - Memory
Delete Params - Params for
memory/delete. Consolidates gatewayMemoryDeleteQuery. - Memory
Delete Result - Memory
Entry - A single memory entry
- Memory
GetParams memory/getparams — fetch one entry’s full content by key.- Memory
GetResult memory/getresult.entrycarries the full content the Memory pane only renders inside the detail modal — list rows store preview-only data.- Memory
List Params - Params for
memory/list. Consolidates gatewayMemoryQuery(list mode). - Memory
List Result - Memory
Search Params - Params for
memory/search. Consolidates gatewayMemoryQuery(search mode). - Memory
Search Result - Memory
Store Params - Params for
memory/store. Consolidates gatewayMemoryStoreBody. - Memory
Store Result - Message
Entry - Personality
File Entry - Consolidates gateway
PersonalityIndexEntry. - Personality
GetParams - Personality
GetResult - Consolidates gateway
PersonalityFileResponse. - Personality
List Params - Personality
List Result - Consolidates gateway
PersonalityIndex. - Personality
PutParams - Personality
PutResult - Consolidates gateway
PersonalityPutResponse. - Personality
Templates Params - Personality
Templates Result - Consolidates gateway
TemplateResponse. - Picker
Item - Consolidates gateway
PickerItem. - Picker
Response - Consolidates gateway
PickerResponse. - Provider
Usage Totals - Per-(provider, model) usage for one turn. Counts every billable attempt, including rejected fallback attempts.
- Quickstart
Apply Params - Quickstart
Dismiss Params - Quickstart
Dismiss Result - Quickstart
Fields Params - Quickstart
Fields Result - Quickstart
State Result - Mirrors
zeroclaw_gateway::api_quickstart::QuickstartState. - Quickstart
Type Option - One row in the Quickstart “Create new …” picker. The TUI and web surfaces both render this list as-is — no hardcoded option lists on either side.
- Quickstart
Validate Params - Runtime
Shell Profile - Safeguard
Fallback Wire - Display-only safeguard-fallback notice on
TurnComplete. - Section
Select Params - Select
Item Response - Consolidates gateway
SelectItemResponse. - Session
Append Params session/appendparams: an assistant message written to the session transcript without running a turn.- Session
Append Result - Session
Approve Params - Session
Approve Result - Session
Cancel Result - Session
Close Result - Session
Configure Params - Session
Configure Result - Session
Delete Result - Session
Entry - Session
GitBranch Result - Session
IdParams - Shared param for methods that only need a session ID:
session/close,session/cancel,session/messages,session/state,session/delete. - Session
Kill Params - Session
Kill Result - Session
List Params - Session
List Result - Session
Messages Params - Session
Messages Result - Session
NewParams - Session
NewResult - Session
Prompt Params - Session
Prompt Result - Session
Rename Params - Session
Rename Result - Session
RunOnce Params session/run-onceparams: create a session, run one prompt, and close the session, in one call. The turn streamssession/updatenotifications likesession/prompt; the response carries the final result.- Session
RunOnce Result - Session
State Result - Session
Steer Params session/steerparams: a message folded into the session’s running turn as its own user turn before the next model round.- Session
Steer Result - Shadowed
Skill Entry - A lower-precedence same-name skill shadowed by a winning skill
- Skill
Bundle Entry - Wire representation of a skill bundle. Consolidates gateway
BundleEntry. - Skill
List Entry - Wire representation of a skill in a list. Consolidates gateway
SkillEntry. - Skills
Bundles Result - Skills
Delete Params - Skills
Delete Result - Skills
List Params - Skills
List Result - Skills
Read Params - Skills
Read Result - Consolidates gateway
SkillReadResponse. - Skills
Write Params - Skills
Write Result - Status
Result - Subscribe
Params - Parameters shared by every
X/subscribemethod. - Subscription
Cancel Params - Subscription
Cancel Result - Subscription
Lagged subscription/lagged: framesfrom_sequp to (not including)resume_seqare gone; delivery continues atresume_seq.- Template
File Entry - Consolidates gateway
TemplateFile. - TuiList
Entry - TuiList
Result - Turn
Usage Totals - Turn-wide usage totals on
TurnComplete, the RPC counterpart of the gateway chat socket’sdoneframe. Totals andusage_by_providerinclude every billable attempt; thelast_*fields and context limits describe the accepted call that served the turn.
Enums§
- Chat
Mode - File
Source - Source hint for how the client obtained the file.
- Memory
Category - Memory categories for organization
- Message
Entry Kind - Prop
Kind - Runtime type classification for config property values.
- Quickstart
Apply Result - Tagged enum — matches the HTTP route’s
ApplyResultshape. - Quickstart
Validate Result - Tagged enum — matches the HTTP route’s
ValidateResultshape so the drift test can compare bytes. - Runtime
Config Kind - Runtime
Shell Family - Safeguard
Fallback Kind Wire - Which leg served a safeguard (refusal-triggered) fallback.
- Session
Update Event - Typed session update events pushed via
session/updatenotifications. Replaces the hand-builtnotification_for_turn_eventfunction. - Turn
Completion Outcome - Wire-stable subset of
crate::rpc::turn::TurnOutcomeforTurnComplete.messagesis intentionally not on the wire — the TUI rebuilds from streamed chunks.