Workflows

update

Update an existing workflow. The request body is the desired custom overlay relative to GroundX defaults, not a delta against the currently stored custom workflow. Omitted steps and omitted step config fields return to defaults. Step null disables or clears that default step. For step configs, omitted prompt and prompt: {} use the default prompt group; prompt: null intentionally uses no prompt group. A name-only update is not metadata-only; include custom processing settings again if they should remain in effect.

Authentication

X-API-Keystring
API Key authentication via header

Path parameters

idstringRequiredformat: "uuid"
The workflowId of the workflow being updated.

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

Update success
workflowobject
Workflow information