SuperAI Flow Platform

Sections

Theme switcher

Retrieve a specific task execution

Retrieve a specific task execution by its unique identifier.

Overview Fetches a single task execution record with all details including input parameters, output data, error information, and execution metadata. Used for detailed inspection of task execution results and debugging.

Resource Identification Task executions are uniquely identified by UUID (id field). This is distinct from the composite key (flow_execution_id, task_name, task_execution_idx) used for creation and filtering.

Use Cases

  • Debugging failed task executions (inspect error field and stack trace)
  • Retrieving task output for display or downstream processing
  • Auditing task execution history and modifications
  • Viewing detailed execution metadata (timestamps, modified_by)

Related Endpoints

  • GET /task-executions - List task executions with filtering
  • PUT /task-executions - Update task execution
  • GET /flow-executions/{id} - View parent flow execution with all tasks

Header Parameters

Authorizationstring

Path Parameters

task_execution_idstring Required

Unique identifier of the task execution to retrieve. This is the UUID assigned when the task execution was created. Task executions are scoped to organization via RLS; attempting to access another organization's task execution returns 404.

Response

200
Object
Task execution successfully retrieved

Response Attributes

created_atnull
errornull
flow_execution_idstring Required

ID of the parent flow execution containing this task. Establishes the execution hierarchy and determines organization scope. All tasks in a flow execution share the same flow_execution_id.

idstring Required

Unique identifier for this task execution. Auto-generated UUID assigned at creation time. Used for direct resource access via GET /task-executions/{id}.

inputstring

Input parameters provided to the task executor. Schema varies by task type; can be object, array, or primitive. NULL if task accepts no input parameters. Resolved from flow definition and upstream task outputs.

modified_bystring

Identifier of the actor who last modified this task execution. Tracks manual interventions vs automated updates for auditing. Defaults to 'system' for worker-initiated changes.

Values:

  • 'system': System-automated changes (workers, background jobs)
  • User ID: UUID string of the user who made the change (e.g., '123e4567-e89b-12d3-a456-426614174000')
  • Integration type: For service accounts/integrations (e.g., 'integration', 'service-account')
Default value
system
organization_idstring Required

ID of the organization owning this task execution. Inherited from parent flow execution for tenant isolation. Used for Row-Level Security (RLS) filtering and authorization. All task executions are scoped to a single organization.

outputnull
statusstring Required

Current execution state of the task. Valid values: 'queued', 'running', 'completed', 'failed', 'deleted', 'stale'.

Status transitions:

  • queued → running: Task execution started
  • running → completed: Task succeeded with output
  • running → failed: Task encountered error
  • any → deleted: Task soft-deleted (hidden from list operations)
  • completed/failed → stale: Task data is outdated
  • <...
task_execution_idxinteger Required

Zero-based execution index tracking task attempts. 0 = first execution, 1 = first retry, 2 = second retry, etc. Increments for each retry or loop iteration of the same task. Combines with flow_execution_id and task_name to form unique composite key.

task_namestring Required

Name of the task as defined in the flow definition YAML. Case-sensitive identifier matching flow configuration. Used to reference task in flow logic and dependency graphs.

Min length
1
Max length
200
updated_atnull
403
Object
Forbidden - User lacks permission to access this task 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

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