workflow_run_test

Tool

workflow_run_test

Start a test run of a workflow’s draft — the live version when there is no draft.

Start a test run of a workflow’s draft — the live version when there is no draft. It executes for real under the same grants, rate limit and kill-switch as any run, and is flagged `test` so it is not read as the Product’s own traffic. Any trigger kind can be tested: `trigger_payload` becomes `trigger.data` as given, neither checked against a manual trigger’s `input_schema` nor filtered by an event trigger’s conditions — a test run is unconditional.

Behavior

HTTP: POST /workflow/runs/test

Arguments

Name	Type	Required	Description
workflow_id	string	•	No description in the catalog.
trigger_payload	object	—	What the run reads as `trigger.data`. Defaults to `{}`.

Response

Field	Type	Always	Description
id	string	•
test	boolean	•	Started by `workflow_run_test` to watch the workflow work. It executed for real; the flag is what separates it from the Product’s own traffic.
status	string	•
version	number	•
ended_at	string	•
created_at	string	•
started_at	string	•
held_reason	string	—	Structured `{ code, tool\|name, hint }` while `status` is `held`; null otherwise.
subject_key	string	•	Who this run is about, rendered once from the definition’s `subject` at run start and frozen. Null when the workflow declares no subject.
workflow_id	string	•
trigger_event_id	string	•
replay_generation	number	•

Try it

Start a test run of a workflow’s draft — the live version when there is no draft.

When to use

Example

Ask your agent something like this:

Start a test run of a workflow’s draft — the live version when there is no draft.

The agent will invoke workflow_run_test with these arguments:

{
  "workflow_id": "<workflow_id>"
}