Skip to main content
Insight Flow exposes its API under the shared /api/v1/ prefix for both the frontend UI and automation workflows.

Conventions

  • Resource APIs live under /api/v1/
  • OpenAPI docs are available at http://localhost:8000/docs
  • Health checks are available at /health
  • Frontend calls are centralized in frontend/src/lib/api.ts

Resource Groups

  • Sources
  • Articles
  • Tasks
  • Reports
  • Monitors
  • Providers
  • Destinations
  • Feed
  • Users

Suggested Reading Order

  1. Sources
  2. Monitors
  3. Reports
  4. Providers
  5. Destinations