Workflows

validate

Validate a workflow definition without creating or modifying anything — a distinct operation from create/update. Accepts the same request body as workflow create, including the yaml field (authored workflow YAML source, compiled server-side). Returns the compiled workflow; validation failures return the same structured errors as create.

Authentication

X-API-Keystring
API Key authentication via header

Request

This endpoint expects an object.
chunkStrategyenumOptional
namestringOptional
The name of the workflow being created.
yamlstringOptional

Authored workflow YAML source. When set, the server compiles it into the canonical workflow structures (steps, prompts, routes) — the other definition fields (extract, customSteps, outputRoutes, leafFields, steps) are derived from it and must be omitted. An extraction-definition-only YAML (groups + field prompts, no workflow block) has its workflow definitions scaffolded server-side.

extractobjectOptional
Extract agent definitions.
templatemap from strings to stringsOptional

Workflow-level prompt template values used by fixed and custom workflow step prompts.

sectionStrategyenumOptional
stepsobjectOptional
A collection of workflow steps
customStepslist of objectsOptional

Workflow-level custom extraction steps. Legacy fixed steps remain under steps.

outputRouteslist of objectsOptional
Custom output routes. Each record must have exactly one matching leafFields record on finalPath, workflowGroup, workflowField, stepName, level, and outputKey.
leafFieldslist of objectsOptional

Custom leaf-field metadata used to validate route integrity and executable-step field counts.

Response

Validation success
workflowobject
Workflow information