SuperAI Flow Platform

Sections

Theme switcher

Retrieve a specific flow execution

Header Parameters

Authorizationstring

Query Parameters

include_run_numberboolean

Calculate and include sequential run number. Adds ~10-20ms overhead. Recommended for UI display only.

Default value
false

Path Parameters

flow_execution_idstring Required

UUID of the flow execution to retrieve. Must exist and not be soft-deleted.

Response

200
Object
Flow execution successfully retrieved

Response Attributes

created_atstring Required
flow_idstring Required

UUID of the flow definition being executed. References the parent flow that defines the workflow structure.

flow_versioninteger Required

Version number of the flow definition used for this execution. Execution continues on the same version even if flow is updated. Ensures consistency throughout execution lifecycle.

Minimum
1
idstring Required
inputobject Required

Input data provided when execution was created. Schema is defined by the flow definition. Commonly includes: file_key, document_url, or custom parameters. Structure varies by flow type.

Show child attributes

modified_bystring Required
organization_idstring Required

UUID of the organization that owns this execution. Used for access control and data isolation. All executions are scoped to an organization.

run_numbernull
Minimum
1
statusstring Required

Current execution status. Possible values: 'queued', 'running', 'in_progress', 'completed', 'failed', 'deleted', 'stale'. Status transitions: queued → running → in_progress → completed/failed. Use 'completed' to indicate success, 'failed' for errors.

updated_atstring Required
400
Object
Bad Request - Invalid execution ID format

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
403
Object
Forbidden - User lacks permission to view this execution

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
404
Object
Not Found - The requested resource does not exist

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