Runs
A run is one execution of a flow, or one turn of an agent. Your app starts it, follows it, and reads what it returned; the journal records every step. Runs, the journal and durability explains the model.
- Start a run: wait for its result, or start it in the background.
- Retry a start safely: an idempotency key, so a retried request doesn't start a second run.
- Follow a run's events: each step as it starts and ends.
- Follow a run from the browser: a short-lived, read-only token, so a page can show progress without your API token.
- Read a run's journal: everything that happened in a run, with each step's input and output.
- Cancel a run: stop a run that's running or waiting.
- List runs: the newest runs, page by page, and the runs inside a run.
- Show runs in your app: keep a run's id on your own row, and read the rest through the API, not Kindgi's database.
The examples use the flows from the flow guides, and a client
for the Kindgi API: @kindgi/sdk/client in TypeScript, kindgi.client in
Python.