Skip to main content

Router catalogue

The API is organised into domain routers registered in src/api/main.py. Each router owns a slice of the platform. The table below groups them by area; for the exact, version-accurate request and response shapes, use the embedded Swagger UI at the Console's API Docs page.

By area

Casework

RouterCovers
investigation_routerInvestigation CRUD, transcripts, ontology views, activity logs
report_routerReport generation, PDF export, findings preview
evidence_routerEvidence retrieval, source-reliability stats
lineage_routerEntity lineage and data provenance

Entities & ontology

RouterCovers
company_routerCompany registry, stats, timeline, ownership
people_routerPerson entities
ontology_router, ontology_entities_router, ontology_company_routerEntity/company queries, graph export, geocoding
ontology_reconciliation_router, ontology_resolution_routerConflict-resolution workflows
ontology_export_routerPer-company PDF/DOCX export
entity_preview_router, sources_routerEntity preview cards, company sources

Graph, risk & analytics

RouterCovers
graph_routerNeo4j queries — centrality, ownership chains, common connections
risk_routerRisk aggregation, category/jurisdiction breakdowns, indicators
analytics_router, metrics_routerCentrality scores, cost/entity metrics

Configuration & tenancy

RouterCovers
settings_routerLLM providers, MCP servers, crew config, prompts, schemas, segments
data_providers_routerProvider registry, country coverage, enrichment
data_provider_credentials_routerTenant-scoped credential CRUD
tenant_routerTenant registry
auth_routerRole assignments, workflow roles (admin)

Orchestration & ops

RouterCovers
temporal_routerWorkflow health & status
pipeline_routerPipeline status, manual module triggers
debug_routerMCP health, pipeline config, workflow internals
health_routerLiveness / readiness

Cross-cutting routers from other packages

Some routers live with their domain package rather than under api/:

RouterPackageCovers
mutation/conflict routersrc/mutation_queue/Mutations, conflicts, provenance
risk-matrix routersrc/risk_matrix/Matrix schemas, assignments, evaluations
reference-data routersrc/reference_data/Datasets, types, adapters
source-contracts routersrc/source_contracts/Provider field definitions
ontology-schema routersrc/ontology_schema/Schema versions, field configs
workflows routerssrc/workflows/Low-code workflow engine, documents

See Backend architecture for how these packages relate, and Mutation queue and Risk scoring for the domains behind the cross-cutting routers.