Documentation
API
Start runs from your systems, read what happened, and pull the audit trail.
What it is for
The API is how your existing systems take part in a workflow. A core banking event starts a run; your case system reads the result; your monitoring pulls the audit trail. It is the same platform, reached by a program instead of a person.
What it does
- Start a run of a published workflow, with input.
- Read a run: its status, its steps, what each produced, and who approved what.
- Receive events when a run finishes or needs a decision.
- Read the audit log, for your own evidence and monitoring.
What it deliberately cannot do
It cannot create, edit or delete a workflow. A token holds an operator seat, never an author's, so no key can quietly rewrite what a workflow does. Changes go through the builder, where they are described and recorded.
A token belongs to a department and reaches only that department's workflows and connections. Calls are recorded the same way a person's actions are.
Shape
- JSON over HTTPS, with a machine-readable description of every operation.
- Errors follow a standard problem format rather than free text.
- Long-running work streams progress instead of holding a request open.
- Requests are rate limited, and limits can be raised per organization.