Create task output

curl --request POST \
  --url https://flows.super.ai/api/task-outputs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "flow_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "summary": "<unknown>",
  "task_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified_by": "<string>",
  "output": null,
  "status": "queued",
  "tags": null,
  "updated_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://flows.super.ai/api/task-outputs"

payload = {
    "flow_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "summary": "<unknown>",
    "task_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modified_by": "<string>",
    "output": None,
    "status": "queued",
    "tags": None,
    "updated_at": "2023-11-07T05:31:56Z"
}
headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-Key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    flow_execution_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    summary: '<unknown>',
    task_name: '<string>',
    created_at: '2023-11-07T05:31:56Z',
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    modified_by: '<string>',
    output: null,
    status: 'queued',
    tags: null,
    updated_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://flows.super.ai/api/task-outputs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flows.super.ai/api/task-outputs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'flow_execution_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'summary' => '<unknown>',
    'task_name' => '<string>',
    'created_at' => '2023-11-07T05:31:56Z',
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'modified_by' => '<string>',
    'output' => null,
    'status' => 'queued',
    'tags' => null,
    'updated_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://flows.super.ai/api/task-outputs"

	payload := strings.NewReader("{\n  \"flow_execution_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"summary\": \"<unknown>\",\n  \"task_name\": \"<string>\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"modified_by\": \"<string>\",\n  \"output\": null,\n  \"status\": \"queued\",\n  \"tags\": null,\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://flows.super.ai/api/task-outputs")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"flow_execution_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"summary\": \"<unknown>\",\n  \"task_name\": \"<string>\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"modified_by\": \"<string>\",\n  \"output\": null,\n  \"status\": \"queued\",\n  \"tags\": null,\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/task-outputs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"flow_execution_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"summary\": \"<unknown>\",\n  \"task_name\": \"<string>\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"modified_by\": \"<string>\",\n  \"output\": null,\n  \"status\": \"queued\",\n  \"tags\": null,\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "flow_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "summary": "<unknown>",
  "task_name": "<string>",
  "created_at": "2025-01-24T10:30:00Z",
  "flow_version": 1,
  "modified_by": "system",
  "output": {
    "extracted_text": "Long document content...",
    "metadata": {
      "author": "John"
    }
  },
  "tags": [
    "priority:high",
    "customer:acme",
    "reviewed"
  ],
  "updated_at": "2025-01-24T10:35:00Z"
}

task-outputs

Create task output

Create a task output record for a completed task and notify connected clients.

Task outputs represent the processed, summarized results of task executions. Unlike task executions which track the full execution lifecycle (input, output, error, status), task outputs focus on the final output data formatted for display, downstream consumption, and workflow decisions.

What Are Task Outputs

Task outputs serve multiple purposes:

Structured Results: Store task results in a queryable format via the summary field
Full Output Data: Provide complete output for downstream task consumption
Metadata Tracking: Associate tags for categorization and filtering
Real-time Updates: Enable WebSocket notifications for UI progress tracking
Workflow Logic: Support decision-making based on task outcomes

Relationship to Task Executions

Task Execution: Full execution record (input, output, error, retries, timing)
Task Output: Summarized result optimized for querying and display
One task execution typically produces one task output upon completion
Task outputs are created by system workers after task completion

Notification Behavior

This endpoint triggers two types of WebSocket notifications asynchronously:

Flow-level notification: Updates all clients subscribed to the flow’s WebSocket
Enhanced notification: Broadcasts to summary-watching clients for real-time updates

Notifications are processed in the background to ensure fast response times (< 100ms).

Common Use Cases

Workers reporting task completion with structured output
Storing task results for display in execution history UI
Providing data for downstream task inputs in workflows
Triggering real-time progress updates
Enabling workflow decisions based on task outcomes

Related Endpoints

GET /task-outputs - List all task outputs
GET /task-outputs/{id} - Get single task output
GET /flow-executions/{id} - View parent flow execution
GET /task-executions - View full task execution details

POST

api

task-outputs

Create task output

curl --request POST \
  --url https://flows.super.ai/api/task-outputs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "flow_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "summary": "<unknown>",
  "task_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified_by": "<string>",
  "output": null,
  "status": "queued",
  "tags": null,
  "updated_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://flows.super.ai/api/task-outputs"

payload = {
    "flow_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "summary": "<unknown>",
    "task_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modified_by": "<string>",
    "output": None,
    "status": "queued",
    "tags": None,
    "updated_at": "2023-11-07T05:31:56Z"
}
headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-Key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    flow_execution_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    summary: '<unknown>',
    task_name: '<string>',
    created_at: '2023-11-07T05:31:56Z',
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    modified_by: '<string>',
    output: null,
    status: 'queued',
    tags: null,
    updated_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://flows.super.ai/api/task-outputs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flows.super.ai/api/task-outputs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'flow_execution_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'summary' => '<unknown>',
    'task_name' => '<string>',
    'created_at' => '2023-11-07T05:31:56Z',
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'modified_by' => '<string>',
    'output' => null,
    'status' => 'queued',
    'tags' => null,
    'updated_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://flows.super.ai/api/task-outputs"

	payload := strings.NewReader("{\n  \"flow_execution_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"summary\": \"<unknown>\",\n  \"task_name\": \"<string>\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"modified_by\": \"<string>\",\n  \"output\": null,\n  \"status\": \"queued\",\n  \"tags\": null,\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://flows.super.ai/api/task-outputs")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"flow_execution_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"summary\": \"<unknown>\",\n  \"task_name\": \"<string>\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"modified_by\": \"<string>\",\n  \"output\": null,\n  \"status\": \"queued\",\n  \"tags\": null,\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/task-outputs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"flow_execution_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"summary\": \"<unknown>\",\n  \"task_name\": \"<string>\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"modified_by\": \"<string>\",\n  \"output\": null,\n  \"status\": \"queued\",\n  \"tags\": null,\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "flow_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "summary": "<unknown>",
  "task_name": "<string>",
  "created_at": "2025-01-24T10:30:00Z",
  "flow_version": 1,
  "modified_by": "system",
  "output": {
    "extracted_text": "Long document content...",
    "metadata": {
      "author": "John"
    }
  },
  "tags": [
    "priority:high",
    "customer:acme",
    "reviewed"
  ],
  "updated_at": "2025-01-24T10:35:00Z"
}

Authorizations

X-API-Key

string

header

required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

X-API-Key: saf_1234567890

Authorization

string

header

required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Body

application/json

Database model for node output.

flow_execution_id

string<uuid>

required

organization_id

string<uuid>

required

summary

any

required

task_name

string

required

created_at

string<date-time>

string<uuid>

modified_by

string

output

unknown

status

enum<string>

default:queued

Valid status values for flow execution lifecycle.

Status Transitions: queued → running → in_progress → completed → failed

Any status → deleted (soft delete)
completed/failed → stale (data outdated)

Status Definitions: - queued: Execution created but workflow not yet started - running: Workflow started, initial tasks executing - in_progress: Workflow actively processing tasks - completed: All tasks finished successfully - failed: One or more tasks failed, workflow stopped - deleted: Soft deleted, hidden from list operations - stale: Previously completed but data is now outdated

Available options:

queued,

running,

in_progress,

completed,

failed,

deleted,

stale,

awaiting_input

Response

Task output successfully created

API model representing a task's output data.

Task outputs store the summarized, structured results of task executions. Unlike task executions which track the full lifecycle (input, output, error), task outputs focus on the final output data formatted for display, downstream consumption, and workflow decision logic.

Key Differences from Task Execution: - Task Execution: Full execution record with input, output, error, retries - Task Output: Summarized result optimized for querying and display - One task execution typically produces one task output upon completion

Resource Hierarchy: Organization → Flow → Flow Execution → Task Output

flow_execution_id

string<uuid>

required

ID of the parent flow execution containing this task. Establishes the execution hierarchy and organization scope.

Example:

"223e4567-e89b-12d3-a456-426614174000"

string<uuid>

required

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

Example:

"123e4567-e89b-12d3-a456-426614174000"

organization_id

string<uuid>

required

ID of the organization owning this task output. Inherited from parent flow execution. Used for Row-Level Security (RLS) and multi-tenant isolation.

Example:

"323e4567-e89b-12d3-a456-426614174000"

status

string

required

Execution status when output was created. Valid values: 'queued', 'running', 'completed', 'failed', 'deleted', 'stale'. Typically 'completed' for successful task outputs.

Status meanings:

queued: Task scheduled but not started
running: Task actively executing
completed: Task finished successfully
failed: Task encountered error (may have partial output)
deleted: Soft-deleted, excluded from queries (preserves audit trail)
stale: Output data is outdated (needs refresh)

Examples:

"queued"

"running"

"completed"

"failed"

"deleted"

"stale"

summary

any

required

Structured summary of task output for UI display and querying. Typically a dictionary with standardized keys for rendering.

Common patterns:

Document processing: {'pages': 10, 'word_count': 5000}
API calls: {'status_code': 200, 'response_time_ms': 450}
Data validation: {'valid_rows': 950, 'invalid_rows': 50}

Examples:

{
  "duration_seconds": 12.5,
  "records_processed": 150,
  "status": "success"
}

{
  "email_sent": true,
  "recipient": "user@example.com"
}

task_name

string

required

Name of the task that produced this output. Case-sensitive identifier matching flow definition YAML. Used to associate output with specific workflow task.

Required string length: 1 - 200

Examples:

"extract_data"

"send_email"

"validate_document"

created_at

string<date-time> | null

ISO 8601 timestamp when task output was created (UTC). Represents when the output was recorded in the system. NULL for legacy records created before timestamp tracking.

Example:

"2025-01-24T10:30:00Z"

flow_version

integer | null

Version number of the flow definition used for execution. Matches flow_version from parent flow execution. NULL for outputs created before version tracking. Useful for tracking output changes across flow versions.

Required range: x >= 1

Example:

1

modified_by

string

default:system

Identifier of the actor who last modified this task output. Tracks who made the last change for auditing purposes. 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')

Examples:

"system"

"123e4567-e89b-12d3-a456-426614174000"

"integration"

output

any | null

Full output data produced by the task. May be large or complex; use summary field for UI display. Can be dict, list, or primitive types. NULL if task produces no output data. Available for downstream task consumption in workflows.

Example:

{
  "extracted_text": "Long document content...",
  "metadata": { "author": "John" }
}