Skip to main content
PATCH
/
v1
/
workflows
/
tests
/
{test_id}
from retab import Retab

client = Retab()

# Rename only.
test = client.workflows.tests.update(
    test_id="wfnodetest_hsLEQiM61ez9Piv147MWk",
    name="Q1 invoice — vendor name check",
)

# Replace the assertion.
test = client.workflows.tests.update(
    test_id="wfnodetest_hsLEQiM61ez9Piv147MWk",
    assertion={
        "target": {"output_handle_id": "output-json-0", "path": "vendor.name"},
        "condition": {"kind": "matches_regex", "expected": r"^Acme.*"},
    },
)

# Re-capture inputs from a different run.
test = client.workflows.tests.update(
    test_id="wfnodetest_hsLEQiM61ez9Piv147MWk",
    source={
        "type": "run_step",
        "run_id": "wfrun_new789",
        "step_id": "block_extract_invoice",
    },
)

{
  "id": "wfnodetest_hsLEQiM61ez9Piv147MWk",
  "workflow_id": "wf_abc123xyz",
  "target": { "type": "block", "block_id": "block_extract_invoice" },
  "source": { "type": "manual", "handle_inputs": { "...": "..." } },
  "name": "Q1 invoice — vendor name check",
  "assertion": { "...": "the new assertion" },
  "schema_drift": "none",
  "validation_status": "valid",
  "latest_run_summary": null,
  "created_at": "2026-04-08T14:22:26Z",
  "updated_at": "2026-05-01T14:35:00Z"
}
Patch the name, assertion, and/or source of a workflow test. Every field is optional in the request body — fields you omit are left untouched. Setting assertion: null is rejected explicitly (use Delete Workflow Test if you want to remove the test entirely). Updating source rebinds where the inputs come from:
  • { type: "manual", handle_inputs: ... } — switch to hand-written inputs.
  • { type: "run_step", run_id: ..., step_id: ... } — re-capture inputs from a different workflow run / step.
The response is the full updated WorkflowTest. 
from retab import Retab

client = Retab()

# Rename only.
test = client.workflows.tests.update(
    test_id="wfnodetest_hsLEQiM61ez9Piv147MWk",
    name="Q1 invoice — vendor name check",
)

# Replace the assertion.
test = client.workflows.tests.update(
    test_id="wfnodetest_hsLEQiM61ez9Piv147MWk",
    assertion={
        "target": {"output_handle_id": "output-json-0", "path": "vendor.name"},
        "condition": {"kind": "matches_regex", "expected": r"^Acme.*"},
    },
)

# Re-capture inputs from a different run.
test = client.workflows.tests.update(
    test_id="wfnodetest_hsLEQiM61ez9Piv147MWk",
    source={
        "type": "run_step",
        "run_id": "wfrun_new789",
        "step_id": "block_extract_invoice",
    },
)

{
  "id": "wfnodetest_hsLEQiM61ez9Piv147MWk",
  "workflow_id": "wf_abc123xyz",
  "target": { "type": "block", "block_id": "block_extract_invoice" },
  "source": { "type": "manual", "handle_inputs": { "...": "..." } },
  "name": "Q1 invoice — vendor name check",
  "assertion": { "...": "the new assertion" },
  "schema_drift": "none",
  "validation_status": "valid",
  "latest_run_summary": null,
  "created_at": "2026-04-08T14:22:26Z",
  "updated_at": "2026-05-01T14:35:00Z"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
test_id
string
required

Body

application/json

Body for updating a workflow test. Only the supplied fields (name, assertion, source) are changed.

​
name
string | null
​
assertion
AssertionSpec · object

Block-test assertion against one declared output handle.

target is the only supported shape: an output handle id and an optional relative path inside that handle's payload.

​
source
ManualWorkflowTestSource · object

Response

Successful Response

A saved workflow test: a target block, an input source, and the assertion evaluated against its output.

​
id
string
required
​
workflow_id
string
required
​
target
WorkflowTestBlockTarget · object
required

Public workflow-test target.

The storage layer remains block-scoped today, but the API shape names the tested entity explicitly so workflow-level targets can be added later.

​
source
ManualWorkflowTestSource · object
required
​
name
string | null
​
assertion
AssertionSpec · object

Block-test assertion against one declared output handle.

target is the only supported shape: an output handle id and an optional relative path inside that handle's payload.

​
assertion_schema_dep
AssertionSchemaDep · object

Single-rule schema dependency for Level 2 drift detection.

​
assertion_drift_status
enum<string> | null
Available options:
valid,
drifted,
broken
​
schema_drift
enum<string>
default:unknown
Available options:
none,
partial,
drifted,
unknown
​
schema_drift_detail
string | null
​
freshness
ArtifactFreshness · object
​
drift
ArtifactDrift · object
​
validation_status
string
default:valid
​
validation_issues
any[]
​
latest_run_summary
LatestBlockTestRunSummary · object

Summary of the most recent block-test run.

Execution status and verdict outcome are exposed as separate fields. The summary is written on terminal-state transitions, so in practice status is one of completed | error | cancelled and outcome is populated when status == "completed".

​
latest_passing_run_summary
LatestBlockTestRunSummary · object

Summary of the most recent block-test run.

Execution status and verdict outcome are exposed as separate fields. The summary is written on terminal-state transitions, so in practice status is one of completed | error | cancelled and outcome is populated when status == "completed".

​
latest_failing_run_summary
LatestBlockTestRunSummary · object

Summary of the most recent block-test run.

Execution status and verdict outcome are exposed as separate fields. The summary is written on terminal-state transitions, so in practice status is one of completed | error | cancelled and outcome is populated when status == "completed".

​
created_at
string<date-time>

When the workflow test was created

​
updated_at
string<date-time>

When the workflow test was last updated