Skip to main content

Module api

Module api 

Source
Expand description

Stable API contracts shared by CLI, Web, and future service adapters.

Structs§

AgentAccessPolicy
Local access policy applied before agent protocol requests reach services.
AgentAccessPolicySummary
Redacted policy status for service diagnostics.
AgentBudgetUsed
Runtime budget consumed by a completed agent retrieval.
AgentProtocolStatus
Service status projection for resident agent protocols.
AgentRequestContext
Unified API context plus agent protocol identity and policy provenance.
AgentRetrievalResult
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.
ApiStreamEvent
A single streaming API event. Each serialized event is one NDJSON line.
AuditQueryApiRequest
Durable audit query request.
AuditQueryResponse
Durable audit query response.
AuditSinkStatus
Durable audit sink health surfaced in service diagnostics.
CodeRepositoryFeatureFlagsResponse
Code repository feature-flag graph response.
CodeRepositoryImpactResponse
Code repository impact response.
CodeRepositoryIndexResponse
Code repository index response.
CodeRepositoryIndexStartResponse
Code repository index start response for queued or no-op index requests.
CodeRepositoryQueryResponse
Code repository retrieval response.
CodeRepositoryRegisterRequest
Code repository registration request.
CodeRepositoryRegisterResponse
Code repository registration response.
CodeRepositoryReportResponse
Code repository operations report response.
CodeRepositoryScopeMetadata
Code repository scope and index metadata attached to code responses.
CodeRepositoryScopePreviewResponse
Code repository scope preview response.
CodeRepositorySetAddResponse
Repository-set member addition response.
CodeRepositorySetCreateResponse
Repository-set creation response.
CodeRepositorySetQueryResponse
Repository-set query response.
CodeRepositorySetRefreshResponse
Repository-set overlay refresh response.
CodeRepositorySetRemoveResponse
Repository-set member removal response.
CodeRepositorySetStatusResponse
Repository-set status response.
CodeRepositoryStatusResponse
Code repository status response.
EmbeddingProviderProbeResponse
Remote embedding provider probe response with secret-free diagnostics.
FileIndexRequest
Bounded local file indexing request.
FileIndexResponse
Local file indexing response.
FileQueryRequest
Bounded local file-location query request.
FileQueryResponse
Local file-location query response.
GraphCanvasEdge
Edge rendered in the Web graph canvas.
GraphCanvasNode
Node rendered in the Web graph canvas.
GraphCanvasRequest
Bounded graph canvas request for same-origin Web exploration.
GraphCanvasResponse
Same-origin graph canvas response.
GraphCanvasSummary
Bounded graph canvas summary for truncation and legend hints.
GraphInspectionRequest
Graph inspection request with optional scope filtering reserved for adapters.
GraphInspectionResponse
Graph inspection response for diagnostics and agent adapters.
HealthResponse
Aggregated health response for CLI/Web/service diagnostics.
HybridRetrievalRequest
Hybrid retrieval request over graph facts and derived indexes.
HybridRetrievalResponse
Retrieval response with freshness and degradation information.
IndexRefreshRequest
Index refresh request. Empty kinds means all v1 index families.
IndexRefreshResponse
Index refresh response after metadata is updated.
IngestClaim
Structured claim supplied to the ingest API.
IngestEvent
Structured event supplied to the ingest API.
IngestEvidence
Evidence item supplied to the ingest API.
IngestEvidenceExtraction
Optional multimodal extraction metadata supplied with an evidence item.
IngestRelation
Structured relation supplied to the ingest API.
IngestRequest
Ingest request shared by CLI, Web, HTTP, and future agent adapters.
IngestResponse
Ingest response with committed graph and refreshed index versions.
MultimodalExtractionRequest
Maintenance-worker output for derived OCR, caption, table, layout, or image embeddings.
MultimodalExtractionResponse
Commit result for a bounded multimodal maintenance batch.
ProjectStatusResponse
Minimal project status response exposed through the unified API layer.
ProposalDecisionApiRequest
Manual proposal decision request.
ProposalDecisionResponse
Manual proposal decision response.
ProposalListApiRequest
Proposal list filter.
ProposalListResponse
Proposal list response.
ProposalShowResponse
Proposal detail response with conflict lifecycle.
RequestContext
Request-scoped identity propagated through application services.
RuntimeIdentity
Runtime identity captured from an agent protocol request.
RuntimeStatus
Resolved runtime paths and network budgets exposed for diagnostics.
ServiceDefinitionWriteResponse
Service definition write response.
ServiceOperatorResponse
Service silent-update operator response.
ServicePlanRequest
Service manager plan request.
ServicePlanResponse
Service manager plan response.
ServiceRecoveryReport
Startup recovery report for resident service mode.
ServiceStatusResponse
Service manager status surfaced without exposing platform-specific handles.
WorkerRunRequest
Bounded foreground worker run request.
WorkerRunResponse
Bounded foreground worker run response.
WorkerStatusRequest
Worker status filter. Missing kind means all worker families.
WorkerStatusResponse
Worker status response.

Enums§

AgentPolicyError
Stable policy validation error.
AgentProtocolKind
Agent protocol family used by external resident-process adapters.
ErrorKind
Stable error categories used across interface adapters.
GraphCanvasKind
Graph canvas view selected by the Web workspace.
InterfaceKind
External interface that initiated a request.
StreamEventKind
Stream event categories for newline-delimited JSON output.

Constants§

GRAPH_CANVAS_DEFAULT_LIMIT
GRAPH_CANVAS_MAX_LIMIT

Functions§

freshness_label