Expand description
Shared request/response types for the ZeroClaw RPC + gateway API surface.
Single source of truth. Every domain’s wire types live here.
The RPC dispatcher, the HTTP gateway, and the TUI client all
import from this module. No ad-hoc json!(), no duplicated structs.
§Conventions
- All structs derive
Debug, Clone, Serialize, Deserialize. - All structs use
#[serde(rename_all = "snake_case")]. - Optional fields use
#[serde(default, skip_serializing_if = "Option::is_none")]. - Types that already exist elsewhere (
MemoryEntry,CronJob,CostSummary,SkillFrontmatter) are re-exported, not re-defined.
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::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
Entry - Agent
Status Entry - Agents
List Result - Agents
Status Result - Builder
Submission - The complete Quickstart submission both surfaces hand to
zeroclaw-runtime::quickstart::apply(and pre-validate viavalidate_only). Single source of truth; assembling config outside this type is a layering bug. - Catalog
Model Provider - Consolidates gateway
CatalogModelProvider. - Catalog
Models Params - Catalog
Models Result - Consolidates gateway
ModelsResponse. - Catalog
Response - Consolidates gateway
CatalogResponse. - Config
Delete Params - Config
Delete Result - Config
Field Entry - Serializable wire representation of a config field for API consumers
(RPC dispatch, gateway, TUI). Single source of truth — replaces the
gateway’s local
ListEntryand the RPC dispatch’s ad-hoc JSON. - 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
Section Entry - A config section entry for the dashboard sidebar / TUI section list.
- Config
Sections Result - Response for
config/sections. - 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 - 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. - 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 - 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. - 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 - Section
Select Params - Select
Item Response - Consolidates gateway
SelectItemResponse. - 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 - Params for
session/messages.limit+before_indexpage-window the load so a long session doesn’t slurp every message into client memory at once. Both default to the legacy “load everything” behaviour for callers that pre-date the pagination change. - Session
Messages Result - Session
NewParams - Session
NewResult - Session
Prompt Params - Session
Prompt Result - Session
State Result - 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 - Template
File Entry - Consolidates gateway
TemplateFile. - TuiList
Entry - TuiList
Result
Enums§
- Chat
Mode - File
Source - Source hint for how the client obtained the file.
- Memory
Category - Memory categories for organization
- 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. - 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.