REST API reference
The API lets your program interact with SereinFlow. Draw a flow in the console, then read it, start it, and inspect results through HTTP. Publish it and create a public interface for stable external access.
For canvas nodes, see Node libraries. To run the service inside ASP.NET Core, see Host integration.
First call
- Read URLs, keys, and errors to confirm API access.
- Find project and flow IDs through Projects and flows API.
- Start and inspect a run through Runs API.
- For external callers, read Flow versions and Public interfaces.
Find endpoints by task
| Task | Reference |
|---|---|
| Find projects and save flows | Projects and flows |
| Publish or roll back a flow | Flow versions |
| Start runs and read outputs or files | Runs, events, and workpieces |
| Upload or upgrade node libraries | Node libraries |
| Invoke published flows externally | Public interfaces |
| Manage runtime settings and keys | Environment and keys |
| Pause and step through a flow | Debug sessions |
This reference lists routes in the current code. The running API's Swagger UI (default http://localhost:8188/swagger) shows full field models and is enabled by default in Development.