Public API Reference (v2.0.0)¶
The stable public surface of fcc, governed by SemVer per
ADR-017. Import the public surface
freely; treat everything else as internal (subject to change without a major
bump). Removals/renames of public symbols happen only in a major release, after
≥1 minor of DeprecationWarning.
Stable public modules¶
| Area | Module | Key public symbols |
|---|---|---|
| Version | fcc |
__version__ |
| Personas | fcc.personas.registry |
PersonaRegistry |
| Personas | fcc.personas.models |
PersonaSpec, RISCEARSpec (.to_dict/.from_dict) |
| Archetypes | fcc.personas.archetypes |
load_archetype_taxonomy, ArchetypeTaxonomy, PAOM_ENUM |
| Vocabulary | fcc.vocab.fqn |
federation_fqn, catalog_fqn, parse_federation_fqn, persona_fqn/archetype_fqn/action_fqn/constitution_fqn |
| Vocabulary | fcc.vocab.store |
VocabStore |
| Messaging | fcc.messaging.events |
Event, EventType |
| Messaging | fcc.messaging.lanes |
LaneRouter |
| Governance | fcc.governance.constitution_registry |
PersonaConstitution, ConstitutionRegistry |
| Contributions | fcc.contributions |
build_dossier, ContributionDossier, federation_summary |
| Observability | fcc.observability.tracing |
FccTracer, SpanData, @traced |
| Observability | fcc.observability.spans |
span-name catalogue + span_* helpers |
| Observability | fcc.observability.collector |
EventStore, CollectorService |
| Protocols | fcc.protocols.portal |
build_portal_components_manifest, validate_component, render_embed_pane |
| Simulation | fcc.simulation.ai_engine |
AISimulationEngine — the __init__ and run() signatures only (promoted v2.2.1 for PAOM's live forward-sim; internals still unstable) |
| Protocols | fcc.protocols.journey |
build_journey_event, emit_journey_event |
| Resources | fcc._resources |
path resolvers (internal-stable — use instead of Path(__file__)) |
Stable served HTTP contracts¶
The probeable surfaces documented in
../ecosystem/partner-probe-guide.md:
ws-bridge /health, UX gateway /ux/*, /.well-known/agent-card.json
(A2A 0.3.0), /api/v1/mcp/info (web-mcp-rest-v1), /.well-known/portal-components.json
(portal-component-v1), /.well-known/contribution-dossier.json
(contribution-dossier-v1), /embed/<component>, admin REST /api/v1/admin/*,
collector /api/v1/events*.
Stable CLI¶
The fcc command surface — command names, options, and documented output
shapes — is public: fcc audit, fcc model-card, fcc catalog export,
fcc contributions dossier, fcc protocol {ws-bridge,ux-gateway,collector,...},
fcc admin serve, fcc scaffold-*.
Stable data contracts¶
src/fcc/data/schemas/*.schema.json, src/fcc/data/exchange_contracts/*, the
catalog export (docs/catalog/v<ver>/*), and the vendored ecosystem registries
(drift-pinned).
Internal (no SemVer promise)¶
_-prefixed modules/symbols; the internals of demos, dashboard, scaffold
(beyond the CLI), simulation (beyond the AISimulationEngine constructor and
run() signatures listed above), rag, search, knowledge builders, and
dev/test tooling. These may change in any release.
Current as of v2.2.1.