Flows

Read Basic Examples

Changed on

Retrieve a list of basic example flows.

get/api/v1/flows/basic_examples/

Request

  • The document declares no server URL.
  • Auth
    • OAuth 2
      Password
      Token URL: api/v1/login
    • or API key in query parameter x-api-key
    • or API key in header x-api-key

Query parameters

include_blockedboolean

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
version_tokenstring uuid nullable

Token identifying the version this response carries

webhookboolean nullable

Can be used on the webhook endpoint

workspace_idstring uuid nullable

Changes

  • 4349fbe90c64Revision changes
    • info

      added the optional property / to the response with the status

  • 088c1fc24528Revision changes
    • info

      the endpoint scheme security API key header was added to the API

    • info

      the endpoint scheme security API key query was added to the API

    • info

      the endpoint scheme security OAuth2PasswordBearerCookie was added to the API

    • info

      added the new optional query request parameter include_blocked

    • info

      added the non-success response with the status