Skip to main content
GET
/
v1
/
workflows
/
{workflow_id}
/
edges
/
{edge_id}
from retab import Retab

client = Retab()

edge = client.workflows.edges.get(
    workflow_id="wf_abc123xyz",
    edge_id="edge-1",
)

print(f"{edge.source_block}/{edge.source_handle} -> {edge.target_block}/{edge.target_handle}")

{
  "id": "edge-1",
  "workflow_id": "wf_abc123xyz",
  "organization_id": "org_123",
  "draft_version": "draft_v3",
  "source_block": "start-1",
  "target_block": "extract-1",
  "source_handle": "output-file-0",
  "target_handle": "input-file-0",
  "updated_at": "2026-04-30T17:00: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.

Get a single edge by ID. 
from retab import Retab

client = Retab()

edge = client.workflows.edges.get(
    workflow_id="wf_abc123xyz",
    edge_id="edge-1",
)

print(f"{edge.source_block}/{edge.source_handle} -> {edge.target_block}/{edge.target_handle}")

{
  "id": "edge-1",
  "workflow_id": "wf_abc123xyz",
  "organization_id": "org_123",
  "draft_version": "draft_v3",
  "source_block": "start-1",
  "target_block": "extract-1",
  "source_handle": "output-file-0",
  "target_handle": "input-file-0",
  "updated_at": "2026-04-30T17:00:00Z"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
workflow_id
string
required
​
edge_id
string
required

Query Parameters

​
access_token
string | null

Response

Successful Response

Edge document connecting two blocks.

Stored in workflow_edges collection. Edges are independently creatable and deletable without affecting block documents.

​
workflow_id
string
required

Foreign key to workflow

​
organization_id
string
required

Organization ID for data isolation

​
source_block
string
required

ID of the source block

​
target_block
string
required

ID of the target block

​
id
string
​
draft_version
string | null

Draft version for live entities

​
source_handle
string | null

Output handle on source block

​
target_handle
string | null

Input handle on target block

​
updated_at
string<date-time>