Export Workflow Spec

Export draft workflow state as canonical declarative YAML.

GET /v1/workflows/{workflow_id}/spec

Python

from retab import Retab

client = Retab()

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

print(exported.yaml_definition)

200

{
  "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"
}

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.

Python

from retab import Retab

client = Retab()

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

print(exported.yaml_definition)

200

{
  "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

200

application/json

Successful Response

A workflow exported as its YAML definition.

workflow_id · string · required

yaml_definition · string · required