Skip to main content
POST
/
v1
/
workflows
/
spec
/
validate
from retab import Retab

client = Retab()

validation = client.workflows.spec.validate(yaml_definition)

print(validation.is_valid)
print(validation.diagnostics)

{
  "workflow_id": "wf_abc123",
  "block_count": 2,
  "edge_count": 1,
  "is_valid": true,
  "diagnostics": {
    "issues": []
  }
}
Validate a declarative workflow YAML spec without changing workflow state. A declarative spec uses apiVersion: workflows.retab.com/v1alpha2. Edges must be explicit and handle-based: 
spec:
  edges:
    - from:
        block: start_document-node
        handle: output-file-0
      to:
        block: extract-node
        handle: input-file-source_doc
Handles are raw runtime handles and are validated against the block type and block configuration. 
from retab import Retab

client = Retab()

validation = client.workflows.spec.validate(yaml_definition)

print(validation.is_valid)
print(validation.diagnostics)

{
  "workflow_id": "wf_abc123",
  "block_count": 2,
  "edge_count": 1,
  "is_valid": true,
  "diagnostics": {
    "issues": []
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Body carrying a workflow's full YAML definition for validate, plan, apply, or export.

​
yaml_definition
string
required

Workflow YAML definition

​
project_id
string | null

Project that should own a workflow created from this spec. Required when applying a spec that creates a new workflow.

Response

Successful Response

Result of validating a workflow YAML definition: whether it is_valid, block/edge counts, and diagnostics.

​
workflow_id
string
required
​
block_count
integer
required
​
edge_count
integer
required
​
is_valid
boolean
required
​
diagnostics
Diagnostics · object
required