Skip to content

API Reference

This section documents the API-layer modules and their callable interfaces. Focus is on what each module does in runtime flow: token registration, request handling, and service exposure.

Package entrypoint

Purpose: package export boundary for API components.

API package for the mounted FastAPI app and internal service facade.

Platform API

Purpose: mounted FastAPI routes, auth/token checks, and externally reachable workflow/analytics endpoints.

REST API foundation layer.

Provides API endpoints for: - workflow execution - governance inspection - analytics retrieval - QA visibility

SEC-005: All mutating endpoints enforce RBAC permissions via the _require_permission dependency. The caller's role is resolved from the authenticated API token owner, and the required permission is checked against the RBACService role registry.