Update flow definition
Update the complete definition of a flow.
Replaces the entire flow definition with a new one. This operation is only allowed for flows in 'draft' status. Creates a new version of the flow.
Restrictions
- Only flows with status 'draft' can be updated
- Published flows cannot be modified
- A new version is created with each update
Validation
- New definition is validated before applying
- If validation fails, the original definition remains unchanged
- Use
include_validation_errors=trueto see validation details
Header Parameters
Query Parameters
Include topologically sorted list of task names in execution order. Useful for visualizing task dependencies. Adds ~50ms latency for complex flows with 20+ tasks.
Include DSL validation errors if the flow definition is malformed. Essential for debugging invalid flows during development. No performance impact as validation runs regardless.
Include runtime configuration options for each task (e.g., dropdown values, available resources). Requires authentication to external services. May add 100-500ms latency depending on integration APIs.
Include JSON Schema definitions for each task's output structure. Required for building dynamic UIs or validating task connections. Adds ~10-50ms latency for schema generation.
Path Parameters
Body Parameters
Response
Response Attributes
Complete flow definition in DSL format. May be enriched with additional fields when using expansion parameters (include_dynamic_data, include_output_schemas). Enriched fields are added to each task within definition.tasks[].
Human-readable flow name
Total number of times this flow has been executed across all versions
Whether this is the latest version of the flow
Organization that owns this flow
Flow lifecycle status. Values: 'draft' (editable), 'published' (ready for production use)
Show child attributes
Show child attributes
Flow version number. Increments on each update.
Response Attributes
Standard error detail structure.
This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.
Show child attributes
Response Attributes
Standard error detail structure.
This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.
Show child attributes
Response Attributes
Standard error detail structure.
This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.
Show child attributes
Response Attributes
Standard error detail structure.
This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.