Create Workflow Test

Create a workflow test.

Pins an expected outcome for one block in a workflow. Provide the workflow_id, the target block, an assertion describing the expected output, and a source of test inputs (explicit handle inputs or a capture from a prior run/step). Returns the created test with status 201.

POST /v1/workflows/tests

Python

from retab import Retab

client = Retab()

# Manual inputs: hand-write the handle inputs the block should run with.
test = client.workflows.tests.create(
    workflow_id="wf_abc123xyz",
    target={"type": "block", "block_id": "block_extract_invoice"},
    source={
        "type": "manual",
        "handle_inputs": {
            "input-document-0": {
                "type": "file",
                "file_id": "file_invoice_q1",
            },
        },
    },
    assertion={
        "target": {"output_handle_id": "output-json-0", "path": "total"},
        "condition": {"kind": "equals", "expected": 1234.56},
    },
    name="Q1 invoice total",
)

# Run-step inputs: replay the inputs the block ACTUALLY received in a run.
test = client.workflows.tests.create(
    workflow_id="wf_abc123xyz",
    target={"type": "block", "block_id": "block_extract_invoice"},
    source={
        "type": "run_step",
        "run_id": "wfrun_def456",
        "step_id": "block_extract_invoice",
    },
    assertion={
        "target": {"output_handle_id": "output-json-0", "path": "vendor.name"},
        "condition": {"kind": "contains", "expected": "Acme"},
    },
)

print(f"Test created: {test.id}")

201

{
  "id": "wfnodetest_hsLEQiM61ez9Piv147MWk",
  "workflow_id": "wf_abc123xyz",
  "target": {
    "type": "block",
    "block_id": "block_extract_invoice"
  },
  "source": {
    "type": "manual",
    "handle_inputs": {
      "input-document-0": {
        "type": "file",
        "file_id": "file_invoice_q1"
      }
    }
  },
  "name": "Q1 invoice total",
  "assertion": {
    "id": "assert_xyz",
    "target": { "output_handle_id": "output-json-0", "path": "total" },
    "condition": { "kind": "equals", "expected": 1234.56 },
    "label": null
  },
  "assertion_schema_dep": {
    "schema_path": "total",
    "subtree_hash": "7d79dd764ab6548d",
    "depends_on_root": false
  },
  "assertion_drift_status": null,
  "schema_drift": "unknown",
  "schema_drift_detail": null,
  "validation_status": "valid",
  "validation_issues": [],
  "latest_run_summary": null,
  "latest_passing_run_summary": null,
  "latest_failing_run_summary": null,
  "created_at": "2026-05-01T14:30:00Z",
  "updated_at": "2026-05-01T14:30:00Z"
}

Create a new workflow test against a single block in the workflow. A workflow test freezes a set of inputs (either captured from a previous run or provided manually) and asserts something about the block’s output the next time it runs.

The create route is flat: send workflow_id in the request body.

The request body has three parts:

• target — the block the test runs against.
• source — where the inputs come from. manual carries an explicit handle_inputs map; run_step references a previous workflow run plus the optional step inside it whose inputs to capture.
• assertion — required. One assertion per test against one declared output handle (see Workflow Tests for the assertion shape and the available operators).

Python

from retab import Retab

client = Retab()

# Manual inputs: hand-write the handle inputs the block should run with.
test = client.workflows.tests.create(
    workflow_id="wf_abc123xyz",
    target={"type": "block", "block_id": "block_extract_invoice"},
    source={
        "type": "manual",
        "handle_inputs": {
            "input-document-0": {
                "type": "file",
                "file_id": "file_invoice_q1",
            },
        },
    },
    assertion={
        "target": {"output_handle_id": "output-json-0", "path": "total"},
        "condition": {"kind": "equals", "expected": 1234.56},
    },
    name="Q1 invoice total",
)

# Run-step inputs: replay the inputs the block ACTUALLY received in a run.
test = client.workflows.tests.create(
    workflow_id="wf_abc123xyz",
    target={"type": "block", "block_id": "block_extract_invoice"},
    source={
        "type": "run_step",
        "run_id": "wfrun_def456",
        "step_id": "block_extract_invoice",
    },
    assertion={
        "target": {"output_handle_id": "output-json-0", "path": "vendor.name"},
        "condition": {"kind": "contains", "expected": "Acme"},
    },
)

print(f"Test created: {test.id}")

201

{
  "id": "wfnodetest_hsLEQiM61ez9Piv147MWk",
  "workflow_id": "wf_abc123xyz",
  "target": {
    "type": "block",
    "block_id": "block_extract_invoice"
  },
  "source": {
    "type": "manual",
    "handle_inputs": {
      "input-document-0": {
        "type": "file",
        "file_id": "file_invoice_q1"
      }
    }
  },
  "name": "Q1 invoice total",
  "assertion": {
    "id": "assert_xyz",
    "target": { "output_handle_id": "output-json-0", "path": "total" },
    "condition": { "kind": "equals", "expected": 1234.56 },
    "label": null
  },
  "assertion_schema_dep": {
    "schema_path": "total",
    "subtree_hash": "7d79dd764ab6548d",
    "depends_on_root": false
  },
  "assertion_drift_status": null,
  "schema_drift": "unknown",
  "schema_drift_detail": null,
  "validation_status": "valid",
  "validation_issues": [],
  "latest_run_summary": null,
  "latest_passing_run_summary": null,
  "latest_failing_run_summary": null,
  "created_at": "2026-05-01T14:30:00Z",
  "updated_at": "2026-05-01T14:30:00Z"
}

Authorizations

Api-Key · string · header · required

Body

application/json

Body to create a workflow test: the target block, an input source, and an assertion to evaluate its output.

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.

Show child attributes

source · ManualWorkflowTestSource · object · required

ManualWorkflowTestSource

RunStepWorkflowTestSource

Show child attributes

assertion · AssertionSpec · object · required

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.

Show child attributes

name · string | null

Response

201

application/json

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.

Show child attributes

source · ManualWorkflowTestSource · object · required

ManualWorkflowTestSource

RunStepWorkflowTestSource

Show child attributes

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.

Show child attributes

assertion_schema_dep · AssertionSchemaDep · object

Single-rule schema dependency for Level 2 drift detection.

Show child attributes

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

Show child attributes

drift · ArtifactDrift · object

Show child attributes

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".

Show child attributes

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".

Show child attributes

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".

Show child attributes

created_at · string<date-time>

When the workflow test was created

updated_at · string<date-time>

When the workflow test was last updated