Files
mission-control/docs/07-api-reference.md
2026-02-11 06:30:08 +00:00

1.4 KiB
Raw Blame History

API reference (first pass)

Deep dives

This is a map of the Mission Control HTTP API surface. Its intentionally light-weight for the first pass.

Base

  • Backend service: backend/app/main.py
  • API prefix: /api/v1

Auth

User/browser auth (Clerk)

  • Used for the human UI.
  • Frontend enables Clerk when NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY is set.
  • Backend verifies JWTs when CLERK_JWKS_URL is configured.

Agent auth (X-Agent-Token)

  • Used by automation/agents.
  • Header: X-Agent-Token: <token>
  • Agent endpoints live under /api/v1/agent/*.

Endpoint groups (routers)

Routers are registered in backend/app/main.py:

  • auth_router
  • agent_router (agent surface)
  • agents_router
  • activity_router
  • gateway_router, gateways_router
  • metrics_router
  • organizations_router
  • souls_directory_router
  • board_groups_router, board_group_memory_router
  • boards_router, board_memory_router, board_onboarding_router
  • approvals_router
  • tasks_router
  • users_router

Examples

Health

curl -s http://localhost:8000/healthz

Agent call (example)

curl -s http://localhost:8000/api/v1/agent/boards \
  -H "X-Agent-Token: $AGENT_TOKEN"

Next

  • Add a per-router table of key paths once we standardize which endpoints are “public” vs “internal”.
  • If an OpenAPI schema exists/gets added, link it here.