Skip to content

Runs

A run is the operator's main unit of work in Agentwerke. It is one execution of a workflow, with its own context, steps, approvals, evidence, and audit trail.

Start a run from the UI

  1. Open the web UI.
  2. Go to Runs.
  3. Choose a workflow or use the seeded sample in the quickstart stack.
  4. Start the run.
  5. Open the run detail page.

The run detail view shows the BPMN diagram, step status, approval state, and run events.

Start a run from the API

Use POST /api/runs with the workflow id.

bash
API=http://localhost:8081
TOKEN=<viewer-or-operator-token>

curl -sf "$API/api/runs" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"workflowId":"wf-first-run-sample"}'

The API returns the new run id. Use that id for follow-up inspection.

Inspect a run

bash
curl -sf "$API/api/runs/<run-id>" \
  -H "Authorization: Bearer $TOKEN" | jq

Look at:

FieldWhat it tells you
statusWhether the run is active, blocked, completed, or failed.
currentStepThe workflow step currently holding the run.
pendingApprovalsNumber of approval requests waiting for a decision.
riskLevelThe current workflow-level risk signal.
startedAt / completedAtRuntime duration and completion state.

Read step history

Each step records status, type, timestamps, agent name, output, and policy decision data. When diagnosing a run, check the first step with a non-success status. The most useful details are usually:

  • The step output.
  • The policy decision rationale.
  • Risk factors.
  • Tool constraints.
  • Audit events around the same timestamp.

Understand common pauses

PauseCauseOperator action
ApprovalA BPMN approval task is waiting.Review and approve, reject, or request changes.
Human questionAn agent used human.ask.Answer the question in the run conversation.
External eventA receive task or catch event is waiting.Deliver the correlated webhook/event or inspect integration health.
TimerA BPMN timer is active.Wait, or verify timer configuration if it is unexpected.

Cancel or recover

Operators can cancel or recover runs through the API and UI surfaces exposed by the product. Prefer recovery when a transient integration, model provider, or dispatch worker issue has been fixed. Prefer cancellation when the run is no longer desired or the underlying workflow definition is wrong.

Before recovery, inspect:

  • Whether the failed step is idempotent.
  • Whether a connector already created an external artifact, branch, issue, or pull request.
  • Whether the run context still matches the current external state.

Operational checklist

  • Confirm the run is on the expected workflow version.
  • Confirm the initiator and trigger context are expected.
  • Check pending approvals before diagnosing a run as stuck.
  • Review tool and policy decisions before retrying a failed agent step.
  • Download the evidence pack before deleting artifacts or tearing down test data.

Apache-2.0 open core. Enterprise-only capabilities are labeled in context.