Skip to navigation
Workflows

update

Replace an existing workflow’s custom settings relative to GroundX defaults. Omitted steps and step settings return to defaults. A null step disables or clears it. For step settings, omit prompt or send prompt: to use default prompts; prompt: null removes the prompt group. A name-only request also resets custom processing settings. Include every custom setting you want to keep.

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
Allowed values:
namestringOptional
The name of the workflow being created.
yamlstringOptional

Workflow YAML. GroundX validates it and creates the workflow settings. When yaml is supplied, omit extract, customSteps, outputRoutes, leafFields, and steps. A v1 workflow declares extraction_policy_version, workflow.custom_steps, workflow.agent_chain, a workflow_step and role for each group, and a workflow_output_key for each routed field. repeats: true declares an array of records; unique_attrs names fields used to identify the same record. For related lists, match_attrs names the shared fields and passthrough.from names the parent group. String matching ignores capitalization and surrounding whitespace. Blank or missing values do not match. When several parents match, GroundX uses the first. Group names and workflow_output_key values become output names.

extractobjectOptional
Extract agent definitions.
templatemap from strings to stringsOptional

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

sectionStrategyenumOptional
Allowed values:
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