Skip to content

Export complete agent architecture

GET
/api/agents/architecture/export

Return a machine-readable snapshot of the declarative architecture.

Consumed by docs generators, diagram tools, and archival/backup tooling.

Successful Response

ExportArchitectureResponse

Complete declarative architecture snapshot returned by /export.

Shape mirrors AgentArchitectureManager.export_architecture() exactly so downstream tools (docs generators, diagram tools, audits) can depend on it.

object
architectureVersion
required
Architectureversion

Architecture schema version

string
generatedAt
required
Generatedat

ISO timestamp of export generation

string
agentCounts
required
AgentCountsInfo

Agent counts by type

object
background
required
Background

Background agents

integer
active
required
Active

Active agents

integer
hybrid
required
Hybrid

Hybrid agents

integer
total
required
Total

Total agents

integer
agents
required
Agents

Declarative agent metadata keyed by agent ID

object
key
additional properties
ArchitectureAgentExportInfo

Single agent row inside an architecture export.

Distinct from AgentStatusInfo (runtime monitoring): this describes the declarative architecture entry — type, category, priority, startup and permission flags — rather than live health.

object
name
required
Name

Display name

string
type
required
Type

Operational type (background/active/hybrid/divine)

string
category
required
Category

Functional category

string
priority
required
Priority

Priority bracket

string
description
required
Description

Agent purpose summary

string
autoStart
required
Autostart

Starts automatically on boot

boolean
userVisible
required
Uservisible

Appears in UI

boolean
canModifySystem
required
Canmodifysystem

May mutate system state

boolean
dependsOn
required
Dependson

Startup dependencies

Array<string>