SuperAI Flow Platform

Sections

Theme switcher

List all flows

List all flows accessible to the authenticated user.

Returns all flows within the user's organization, ordered by creation date (newest first). Each flow includes its latest version by default.

Expansion Parameters

Use query parameters to include additional computed fields. See FlowResponse model documentation for details on available expansion parameters and their performance impact.

Common Use Cases

  • Display flows in dashboard/listing page
  • Populate flow selector dropdown
  • Validate flow definitions in batch

Header Parameters

Authorizationstring

Query Parameters

include_ordered_task_namesboolean

Include topologically sorted list of task names in execution order. Useful for visualizing task dependencies. Adds ~50ms latency for complex flows with 20+ tasks.

Default value
false
include_validation_errorsboolean

Include DSL validation errors if the flow definition is malformed. Essential for debugging invalid flows during development. No performance impact as validation runs regardless.

Default value
false
include_dynamic_databoolean

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.

Default value
false
include_output_schemasboolean

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.

Default value
false

Response

200
Object
List of flows successfully retrieved

Response Attributes

created_atstring Required
definitionobject Required

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[].

descriptionnull
display_namestring Required

Human-readable flow name

flow_executions_countinteger

Total number of times this flow has been executed across all versions

Default value
0
idstring Required
is_latestboolean Required

Whether this is the latest version of the flow

modified_bystring Required
organization_idstring Required

Organization that owns this flow

settingsnull
statusstring Required

Flow lifecycle status. Values: 'draft' (editable), 'published' (ready for production use)

task_namesnull

Show child attributes

updated_atstring Required
validation_errorsnull

Show child attributes

versioninteger Required

Flow version number. Increments on each update.

Minimum
1
401
Object
Unauthorized - Missing or invalid authentication credentials

Response Attributes

errorobject Required

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

request_idnull
422
Object
Validation Error

Response Attributes

detailarray

Show child attributes

500
Object
Internal Server Error - An unexpected error occurred

Response Attributes

errorobject Required

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

request_idnull
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot