Flows

Read Basic Examples

Retrieve a list of basic example flows. Args: session (Session): The database session. Returns: list[FlowRead]: A list of basic example flows.

get/api/v1/flows/basic_examples/

Response

Successful Response

namestring required

descriptionstring nullable

iconstring nullable

icon_bg_colorstring nullable

gradientstring nullable

dataobject nullable

is_componentboolean nullable

updated_atstring date-time nullable

webhookboolean nullable

Can be used on the webhook endpoint

endpoint_namestring nullable

tagsstring[] nullable

The tags of the flow

lockedboolean nullable

mcp_enabledboolean nullable

Can be exposed in the MCP server

action_namestring nullable

The name of the action associated with the flow

action_descriptionstring nullable

The description of the action associated with the flow

access_type'PRIVATE' | 'PUBLIC'

idstring uuid required

user_idstring uuid nullable required

folder_idstring uuid nullable required