OpenAPI Specification
The complete REST API is defined as an OpenAPI 3.0 specification. View the machine-readable spec or the interactive Swagger UI:
- 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>
Routing Planes
| Prefix | Plane | Purpose |
|---|---|---|
/service/{capability}/* |
Capability Plane | Business operations |
/hub/* |
Management Plane | App lifecycle, health |
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 api.http for VS Code REST Client / IntelliJ HTTP Client examples.