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

client = Retab()

exported = client.workflows.spec.get("wf_abc123")

print(exported.yaml_definition)

{
  "workflow_id": "wf_abc123",
  "yaml_definition": "apiVersion: workflows.retab.com/v1alpha2\nkind: Workflow\nmetadata:\n  id: wf_abc123\n  name: Invoice Workflow\nspec:\n  blocks:\n    start_document-node:\n      type: start_document\n      label: Input Document\n  edges: []\n"
}

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.

Export the current draft workflow as canonical declarative YAML. Exports use apiVersion: workflows.retab.com/v1alpha2 and include raw explicit handles on every non-synthetic edge. 
from retab import Retab

client = Retab()

exported = client.workflows.spec.get("wf_abc123")

print(exported.yaml_definition)

{
  "workflow_id": "wf_abc123",
  "yaml_definition": "apiVersion: workflows.retab.com/v1alpha2\nkind: Workflow\nmetadata:\n  id: wf_abc123\n  name: Invoice Workflow\nspec:\n  blocks:\n    start_document-node:\n      type: start_document\n      label: Input Document\n  edges: []\n"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
workflow_id
string
required

Response

Successful Response

​
workflow_id
string
required
​
yaml_definition
string
required