Skip to main content
PATCH
/
v1
/
workflows
/
{workflow_id}
/
blocks
/
{block_id}
from retab import Retab

client = Retab()

# Move + rename
block = client.workflows.blocks.update(
    workflow_id="wf_abc123xyz",
    block_id="extract-1",
    label="Extract Invoice Fields v2",
    position_x=480,
    position_y=160,
)

# Replace the config (e.g. tighten the schema, switch model)
block = client.workflows.blocks.update(
    workflow_id="wf_abc123xyz",
    block_id="extract-1",
    config={
        "model": "gpt-5-mini",
        "json_schema": {
            "type": "object",
            "properties": {
                "invoice_number": {"type": "string"},
                "total": {"type": "number"},
                "vendor": {
                    "type": "object",
                    "properties": {"name": {"type": "string"}}
                }
            },
        },
    },
)

{
  "id": "extract-1",
  "workflow_id": "wf_abc123xyz",
  "organization_id": "org_123",
  "draft_version": "draft_v3",
  "type": "extract",
  "label": "Extract Invoice Fields v2",
  "position_x": 480,
  "position_y": 160,
  "width": null,
  "height": null,
  "config": {
    "model": "gpt-5",
    "json_schema": {
      "type": "object",
      "properties": {"total": {"type": "number"}}
    }
  },
  "parent_id": null,
  "resolved_schemas": {
    "input_schemas": {},
    "output_schemas": {
      "output-json-0": {
        "type": "object",
        "properties": {"total": {"type": "number"}}
      }
    }
  },
  "updated_at": "2026-05-01T14:30:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.retab.com/llms.txt

Use this file to discover all available pages before exploring further.

Patch a block with partial data. Only the fields you supply are touched; everything else is left as-is. Common reasons to call this:
  • Reposition on the canvas — position_x / position_y / width / height
  • Rename the block — label
  • Reconfigure the block — config (replaces the existing config; merge it client-side first if you want a partial change)
  • Reparent into or out of a container — parent_id
type is intentionally not patchable. To change a block’s type, delete it and create a new one with the same id. 
from retab import Retab

client = Retab()

# Move + rename
block = client.workflows.blocks.update(
    workflow_id="wf_abc123xyz",
    block_id="extract-1",
    label="Extract Invoice Fields v2",
    position_x=480,
    position_y=160,
)

# Replace the config (e.g. tighten the schema, switch model)
block = client.workflows.blocks.update(
    workflow_id="wf_abc123xyz",
    block_id="extract-1",
    config={
        "model": "gpt-5-mini",
        "json_schema": {
            "type": "object",
            "properties": {
                "invoice_number": {"type": "string"},
                "total": {"type": "number"},
                "vendor": {
                    "type": "object",
                    "properties": {"name": {"type": "string"}}
                }
            },
        },
    },
)

{
  "id": "extract-1",
  "workflow_id": "wf_abc123xyz",
  "organization_id": "org_123",
  "draft_version": "draft_v3",
  "type": "extract",
  "label": "Extract Invoice Fields v2",
  "position_x": 480,
  "position_y": 160,
  "width": null,
  "height": null,
  "config": {
    "model": "gpt-5",
    "json_schema": {
      "type": "object",
      "properties": {"total": {"type": "number"}}
    }
  },
  "parent_id": null,
  "resolved_schemas": {
    "input_schemas": {},
    "output_schemas": {
      "output-json-0": {
        "type": "object",
        "properties": {"total": {"type": "number"}}
      }
    }
  },
  "updated_at": "2026-05-01T14:30:00Z"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
workflow_id
string
required
​
block_id
string
required

Query Parameters

​
access_token
string | null

Body

application/json

Request to update a block. Only provided fields are updated.

​
label
string | null
​
position_x
number | null
​
position_y
number | null
​
width
number | null
​
height
number | null
​
config
Config · object
​
parent_id
string | null

Response

Successful Response

Individual block document for live editing.

Stored in workflow_blocks collection. Each block is independently updatable, enabling targeted position and config updates without loading the entire workflow.

​
workflow_id
string
required

Foreign key to workflow

​
organization_id
string
required

Organization ID for data isolation

​
type
enum<string>
required

Block type (extract, parse, classifier, etc.)

Available options:
start,
start_json,
note,
parse,
edit,
extract,
split,
classifier,
conditional,
hil,
api_call,
function,
while_loop,
for_each,
merge_dicts,
while_loop_sentinel_start,
while_loop_sentinel_end,
for_each_sentinel_start,
for_each_sentinel_end
​
id
string
​
draft_version
string | null

Draft version for live entities

​
label
string
default:""

Display label for the block

​
position_x
number
default:0

X position on canvas

​
position_y
number
default:0

Y position on canvas

​
width
number | null

Block width for resizable blocks

​
height
number | null

Block height for resizable blocks

​
config
Config · object

Block-specific configuration

​
field_ref_snapshot
Field Ref Snapshot · object

Merkle subtree hashes for authored field references; refreshed by schema propagation. Block metadata, not authored config.

​
resolved_schemas
Resolved Schemas · object

Transient sidecar of graph-derived schemas (input_schemas, output_schemas, field_ref_drift). Attached on transport responses; never persisted. Exclude from all DB writes via .model_dump(exclude={'resolved_schemas'}).

​
parent_id
string | null

ID of parent container (while_loop, for_each)

​
updated_at
string<date-time>