Create Workflow Block Execution

Create a block execution for block_id against the current draft.

POST /v1/workflows/blocks/executions

Python

from retab import Retab

client = Retab()

block_execution = client.workflows.blocks.executions.create(
    run_id="run_abc123xyz",
    block_id="blk_extract_1",
    step_id="step_iter_0_blk_extract_1",
    n_consensus=5,
)

200

{
  "id": "wfsim_abc123",
  "run_id": "run_abc123xyz",
  "block_id": "blk_extract_1",
  "lifecycle": { "status": "completed" }
}

Create a workflow block execution from a prior run.

Python

from retab import Retab

client = Retab()

block_execution = client.workflows.blocks.executions.create(
    run_id="run_abc123xyz",
    block_id="blk_extract_1",
    step_id="step_iter_0_blk_extract_1",
    n_consensus=5,
)

200

{
  "id": "wfsim_abc123",
  "run_id": "run_abc123xyz",
  "block_id": "blk_extract_1",
  "lifecycle": { "status": "completed" }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Re-run a single block.

block_id is the block to run; run_id is the workflow run that supplied the original inputs. step_id optionally selects a specific step whose inputs should be used, which is useful for blocks inside a for_each loop.

run_id · string · required

Workflow run id that owns the step.

block_id · string · required

Workflow block id to execute.

step_id · string | null

Optional concrete step id whose inputs should be used. When omitted, the block id is used to look up the step.

n_consensus · integer | null

Optional override for n_consensus on extract / split / classifier blocks. Must be 3, 5, or 7.

check_eligibility · boolean · default: true

Whether to verify the upstream subgraph hasn't drifted since the source run. Disable only for explicit force-rerun flows.

Response

201

application/json

Successful Response

The result of executing a single workflow block.

The execution state is carried by the lifecycle field.

id · string · required

Unique block execution ID

workflow_id · string · required

Workflow the block belongs to

source_run_id · string · required

Workflow run whose inputs were used

block_id · string · required

ID of the block that was executed

block_type · string · required

Type of the block

lifecycle · PendingBlockExecutionLifecycle · object · required

The execution row exists but has not been dispatched.

PendingBlockExecutionLifecycle

QueuedBlockExecutionLifecycle

RunningBlockExecutionLifecycle

CompletedBlockExecutionLifecycle

ErrorBlockExecutionLifecycle

CancelledBlockExecutionLifecycle

SkippedBlockExecutionLifecycle

Show child attributes

workflow_version_id · string

Workflow version whose source run supplied inputs

handle_inputs · Handle Inputs · object

Input payloads keyed by handle ID (file metadata for files, data for json)

Show child attributes

artifact · StepArtifactRef · object

Reference to the artifact produced by this block execution, if any.

Show child attributes

handle_outputs · Handle Outputs · object

Output payloads keyed by handle ID

Show child attributes

routing_decisions · string[] | null

Active output handles for routing decisions

duration_ms · number | null

Duration of the block execution in milliseconds

created_at · string<date-time>

When the block execution record was created

started_at · string<date-time>

When the block execution started

completed_at · string<date-time>

When the block execution completed

handle_inputs_fingerprint · string

workflow_draft_fingerprint · string

block_config_fingerprint · string

execution_fingerprint · string

block_config · Block Config · object

The draft block config used for this block execution

source_step_id · string | null

The step ID that was used for inputs (includes iteration prefix if applicable)

available_iterations · Available Iterations · object[] | null

When the block has multiple iterations, lists all available ones