API Reference
Orrery exposes a RESTful HTTP API documented with OpenAPI 3.0.
Interactive docs
Orrery ships with a built-in interactive API explorer powered by Scalar . It is available directly from your running server — no separate setup needed:
http://localhost:3000/docsUse it to browse all endpoints, try requests against a live server, and download the OpenAPI spec.
OpenAPI spec
Download the raw spec:
http://localhost:3000/api-spec.jsonEndpoint groups
| Group | Prefix | Description |
|---|---|---|
| Definitions | /api/definitions | Deploy and manage BPMN processes |
| Instances | /api/instances | Start and monitor process instances |
| Tasks | /api/tasks | Claim and complete user/service tasks |
| External Tasks | /api/external-tasks | Long-polling worker pattern |
| Messages | /api/messages | Correlate messages to instances |
| Signals | /api/signals | Broadcast signals |
| Timers | /api/timers | Manage scheduled timers |
| Metrics | /api/metrics | Dashboard counters |
Last updated on