client.runs is the shared run API for workflow, agent, manual, and eval runs.
Start
client.run_and_wait or poll manually:
Get
expand:
List
Subresources
Artifacts
client.files.
Python
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
client.runs is the shared run API for workflow, agent, manual, and eval runs.
started = client.run("workflows.extract-invoice", input={})
result = client.run(
"workflows.extract-invoice",
input={},
wait_for_completion=60,
)
client.run_and_wait or poll manually:
final = client.run_and_wait("agents.invoice-agent", input={})
run = client.runs.get(started.id)
# { id, type, finished, execution, output?, files?, error?, timing, ... }
expand:
run = client.runs.get(started.id, expand=["usage", "execution"])
print(run.output, run.usage, run.execution)
listing = client.runs.list(
type="workflow",
status="failed,cancelled",
limit=50,
)
client.runs.usage(started.id)
client.runs.steps(started.id)
client.runs.events(started.id)
client.runs.trace.get(started.id)
client.runs.reviews.get(started.id)
client.runs.reviews.update(started.id, {"note": "Looks wrong", "verdict": "incorrect", "status": "open"})
artifacts = client.runs.artifacts.list(started.id)
content = client.runs.artifacts.download(started.id, artifacts.artifacts[0].path)
client.files.
client.runs.cancel(started.id)
rerun = client.rerun(started.id, wait_for_completion=60)
result = client.runs.promote(started.id, name="golden-invoice")
print(result.example_id, result.name)