Get Step

Get step status and handle data for a specific step in a workflow run.

GET /v1/workflows/runs/{run_id}/steps/{node_id}

python

from retab import Retab

client = Retab()

step = client.workflows.runs.steps.get("run_abc123xyz", "extract-node-1")

print(step.status)
print(step.extracted_data)

if step.handle_outputs:
    payload = step.handle_outputs["output-json-0"]
    print(payload.type)
    print(payload.data)

200

{
  "node_id": "extract-node-1",
  "node_type": "extract",
  "node_label": "Extract Data",
  "status": "completed",
  "handle_outputs": {
    "output-json-0": {
      "type": "json",
      "data": {
        "invoice_number": "INV-2024-001",
        "total_amount": 1234.56,
        "vendor_name": "Acme Corp"
      }
    }
  },
  "handle_inputs": {
    "input-file-0": {
      "type": "file",
      "document": {
        "id": "file_123",
        "filename": "invoice.pdf",
        "mime_type": "application/pdf"
      }
    }
  }
}

Get step status and handle data for a specific step in a workflow run. Use this to inspect the normalized inputs and outputs for a particular node after or during execution.

python

from retab import Retab

client = Retab()

step = client.workflows.runs.steps.get("run_abc123xyz", "extract-node-1")

print(step.status)
print(step.extracted_data)

if step.handle_outputs:
    payload = step.handle_outputs["output-json-0"]
    print(payload.type)
    print(payload.data)

200

{
  "node_id": "extract-node-1",
  "node_type": "extract",
  "node_label": "Extract Data",
  "status": "completed",
  "handle_outputs": {
    "output-json-0": {
      "type": "json",
      "data": {
        "invoice_number": "INV-2024-001",
        "total_amount": 1234.56,
        "vendor_name": "Acme Corp"
      }
    }
  },
  "handle_inputs": {
    "input-file-0": {
      "type": "file",
      "document": {
        "id": "file_123",
        "filename": "invoice.pdf",
        "mime_type": "application/pdf"
      }
    }
  }
}

Authorizations

Api-Key · string · header · required

Path Parameters

run_id · string · required

node_id · string · required

Query Parameters

access_token · string | null

Response

200

application/json

Successful Response

Public response containing step status and handle data.

node_id · string · required

ID of the node

node_type · string · required

Type of the node

node_label · string · required

Label of the node

status · string · required

Step status

handle_outputs · Handle Outputs · object

Handle outputs keyed by handle ID

handle_inputs · Handle Inputs · object

Handle inputs keyed by handle ID (what this node received)