OpenAPI Artifacts
Swagger is an auxiliary surface and does not fully define all HTTP routes. Use it as a quick reference alongside server handlers and user-guide documentation:
- swagger.yaml — OpenAPI 3.0 spec (YAML)
- swagger.json — OpenAPI 3.0 spec (JSON)
-
http://localhost:6060/swagger/index.html— Swagger UI (when server is running)
Quick Reference
Base URL
http://localhost:6060
Configured via listen in
flowbot.yaml (default :6060).
Authentication
X-AccessToken: <your-token>
Primary HTTP Surfaces
| Prefix | Plane | Purpose |
|---|---|---|
/service/{module}/* |
Module Routes | Business operations |
/hub/* |
Management Plane | App lifecycle, health |
/chatagent/* |
Chat Agent API | Agent HTTP endpoints |
Health Probes
| Endpoint | Method | Description |
|---|---|---|
/livez |
GET | Liveness probe |
/readyz |
GET | Readiness probe |
/startupz |
GET | Startup probe |
/metrics |
GET | Prometheus metrics |
HTTP Request Examples
See docs/api/README.md for the current API artifact layout and HTTP example guidance.