Runs

These guides start, follow, read and manage 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.
• Run on a schedule: an agent or a flow at set times, as you, with a history of each time it ran or why it didn't.
• 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.
• See why runs failed: one run's cause, and a project's failed runs counted by cause and by version.
• 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.
• Keep files with a run: store a file as an artifact, with its run or in a project, and download it later.

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.