Skip to main content

API Reference

Formal OpenAPI is not linked yet, but the following control-plane surfaces are now frozen as the minimum pre-OpenAPI contract.

Currently Frozen Minimal Control-Plane Surfaces

Current Constraints

  • The three status surfaces are intended to return 200 OK with a JSON status object that distinguishes placeholder / ready / degraded.
  • /api/v1/system/info may additionally expose a runtime summary describing the current runtime mode and persistence-capability boundary, but it must not leak DSN values, tokens, or other sensitive configuration.
  • POST /api/v1/approvals is now a shipped approval-ticket creation API; it returns 201 Created with the full binding context when the approval repository is configured, and a structured 503 Service Unavailable when it is not.
  • approval binding semantics remain frozen around at least subject_id, env, resource, and action; command_hash remains the recommended CLI/Agent binding.
  • POST /api/v1/compose/import currently takes normalized Compose fields plus optional strict; successful report generation returns 200 OK even when passed=false.
  • POST /api/v1/installer/actions currently requires task_id, action, resource, and env; action is frozen to installer.run.execute. correlation_id may be supplied explicitly or inherited from the current request context correlation ID.
  • /api/v1/databases and /api/v1/storage/objects are visibility-only surfaces for now; they do not execute queries, upload/delete objects, or expose provider control.
  • /api/v1/aidb/query should now return a structured legacy-only / migration-needed response instead of raw 501.