v21

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01144108427.9 KB
Flows

Update Flow

Update a flow.

patch/api/v1/flows/{flow_id}

Path parameters

flow_idstring uuid required

Request body

a2a_card_overridesobject nullable
a2a_enabledboolean nullable
access_type'PRIVATE' | 'PUBLIC'
action_descriptionstring nullable
action_namestring nullable
dataobject nullable
descriptionstring nullable
endpoint_namestring nullable
flow_type'workflow' | 'agent'
folder_idstring uuid nullable
fs_pathstring nullable
lockedboolean nullable
mcp_enabledboolean nullable
namestring nullable
workspace_idstring uuid nullable

Response

Successful Response

a2a_card_overridesobject nullable

User overrides for the generated A2A agent card (skill description, examples, tags)

a2a_enabledboolean nullable

Can be exposed as an A2A agent (only meaningful when flow_type=agent)

access_type'PRIVATE' | 'PUBLIC'
action_descriptionstring nullable

The description of the action associated with the flow

action_namestring nullable

The name of the action associated with the flow

dataobject nullable
descriptionstring nullable
endpoint_namestring nullable
flow_type'workflow' | 'agent'
folder_idstring uuid nullable required
gradientstring nullable
iconstring nullable
icon_bg_colorstring nullable
idstring uuid required
is_componentboolean nullable
lockedboolean nullable
mcp_enabledboolean nullable

Can be exposed in the MCP server

namestring required
name_keystring nullable

Stable i18n key derived from the original English name

tagsstring[] nullable

The tags of the flow

updated_atstring date-time nullable
user_idstring uuid nullable required
webhookboolean nullable

Can be used on the webhook endpoint

workspace_idstring uuid nullable