Skip to content

API specifications

This directory holds the platform's HTTP API contract.

There is no HTTP API in Phase 0 — the platform is driven by the aop CLI. The FastAPI service is introduced in Phase 3 (Orchestrator Engine), at which point its OpenAPI document will be exported here as openapi.json (generated from the FastAPI app, not hand-written), e.g.:

python -m aop.api.export_openapi > docs/api/openapi.json

Until then, the machine-readable contracts that exist today are the JSON Schemas under ../schemas, and the CLI itself documents its surface via aop --help.