Expand description
Stable API contracts shared by CLI, Web, and future service adapters.
Structs§
- Agent
Access Policy - Local access policy applied before agent protocol requests reach services.
- Agent
Access Policy Summary - Redacted policy status for service diagnostics.
- Agent
Budget Used - Runtime budget consumed by a completed agent retrieval.
- Agent
Protocol Status - Service status projection for resident agent protocols.
- Agent
Request Context - Unified API context plus agent protocol identity and policy provenance.
- Agent
Retrieval Result - Canonical retrieval result shared by MCP and future agent protocols.
- ApiError
- API error shape suitable for JSON and streaming output.
- ApiMetadata
- Common metadata that every successful API response must carry.
- ApiStream
Event - A single streaming API event. Each serialized event is one NDJSON line.
- Audit
Query ApiRequest - Durable audit query request.
- Audit
Query Response - Durable audit query response.
- Audit
Sink Status - Durable audit sink health surfaced in service diagnostics.
- Code
Repository Impact Response - Code repository impact response.
- Code
Repository Index Response - Code repository index response.
- Code
Repository Query Response - Code repository retrieval response.
- Code
Repository Register Request - Code repository registration request.
- Code
Repository Register Response - Code repository registration response.
- Code
Repository Report Response - Code repository operations report response.
- Code
Repository Scope Metadata - Code repository scope and index metadata attached to code responses.
- Code
Repository Scope Preview Response - Code repository scope preview response.
- Code
Repository Status Response - Code repository status response.
- Embedding
Provider Probe Response - Remote embedding provider probe response with secret-free diagnostics.
- File
Index Request - Bounded local file indexing request.
- File
Index Response - Local file indexing response.
- File
Query Request - Bounded local file-location query request.
- File
Query Response - Local file-location query response.
- Graph
Canvas Edge - Edge rendered in the Web graph canvas.
- Graph
Canvas Node - Node rendered in the Web graph canvas.
- Graph
Canvas Request - Bounded graph canvas request for same-origin Web exploration.
- Graph
Canvas Response - Same-origin graph canvas response.
- Graph
Canvas Summary - Bounded graph canvas summary for truncation and legend hints.
- Graph
Inspection Request - Graph inspection request with optional scope filtering reserved for adapters.
- Graph
Inspection Response - Graph inspection response for diagnostics and agent adapters.
- Health
Response - Aggregated health response for CLI/Web/service diagnostics.
- Hybrid
Retrieval Request - Hybrid retrieval request over graph facts and derived indexes.
- Hybrid
Retrieval Response - Retrieval response with freshness and degradation information.
- Index
Refresh Request - Index refresh request. Empty
kindsmeans all v1 index families. - Index
Refresh Response - Index refresh response after metadata is updated.
- Ingest
Claim - Structured claim supplied to the ingest API.
- Ingest
Event - Structured event supplied to the ingest API.
- Ingest
Evidence - Evidence item supplied to the ingest API.
- Ingest
Evidence Extraction - Optional multimodal extraction metadata supplied with an evidence item.
- Ingest
Relation - Structured relation supplied to the ingest API.
- Ingest
Request - Ingest request shared by CLI, Web, HTTP, and future agent adapters.
- Ingest
Response - Ingest response with committed graph and refreshed index versions.
- Multimodal
Extraction Request - Maintenance-worker output for derived OCR, caption, table, layout, or image embeddings.
- Multimodal
Extraction Response - Commit result for a bounded multimodal maintenance batch.
- Project
Status Response - Minimal project status response exposed through the unified API layer.
- Proposal
Decision ApiRequest - Manual proposal decision request.
- Proposal
Decision Response - Manual proposal decision response.
- Proposal
List ApiRequest - Proposal list filter.
- Proposal
List Response - Proposal list response.
- Proposal
Show Response - Proposal detail response with conflict lifecycle.
- Request
Context - Request-scoped identity propagated through application services.
- Runtime
Identity - Runtime identity captured from an agent protocol request.
- Runtime
Status - Resolved runtime paths and network budgets exposed for diagnostics.
- Service
Definition Write Response - Service definition write response.
- Service
Operator Response - Service silent-update operator response.
- Service
Plan Request - Service manager plan request.
- Service
Plan Response - Service manager plan response.
- Service
Recovery Report - Startup recovery report for resident service mode.
- Service
Status Response - Service manager status surfaced without exposing platform-specific handles.
- Worker
RunRequest - Bounded foreground worker run request.
- Worker
RunResponse - Bounded foreground worker run response.
- Worker
Status Request - Worker status filter. Missing kind means all worker families.
- Worker
Status Response - Worker status response.
Enums§
- Agent
Policy Error - Stable policy validation error.
- Agent
Protocol Kind - Agent protocol family used by external resident-process adapters.
- Error
Kind - Stable error categories used across interface adapters.
- Graph
Canvas Kind - Graph canvas view selected by the Web workspace.
- Interface
Kind - External interface that initiated a request.
- Stream
Event Kind - Stream event categories for newline-delimited JSON output.