List task summaries for flow version

curl --request GET \
  --url https://flows.super.ai/api/flows/{flow_id}/versions/{version}/summary \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://flows.super.ai/api/flows/{flow_id}/versions/{version}/summary"

headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-Key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://flows.super.ai/api/flows/{flow_id}/versions/{version}/summary', 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/flows/{flow_id}/versions/{version}/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://flows.super.ai/api/flows/{flow_id}/versions/{version}/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://flows.super.ai/api/flows/{flow_id}/versions/{version}/summary")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/flows/{flow_id}/versions/{version}/summary")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "flow_execution_id": "550e8400-e29b-41d4-a716-446655440000",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modified_by": "<string>",
    "status": "completed",
    "summary": {
      "duration_seconds": 12.5,
      "processed_items": 42
    },
    "task_name": "process_document",
    "updated_at": "2023-11-07T05:31:56Z",
    "flow_version": 3,
    "tags": [
      "priority:high",
      "type:extraction"
    ]
  }
]

flows

List task summaries for flow version

List task execution summaries for a specific flow version.

Returns lightweight task summaries without full output data, reducing network overhead when you only need execution metadata.

Performance Benefits

Excludes potentially large task output fields
Significantly faster response times for flows with large outputs
Ideal for listing/summary views

Use Cases

Display execution history in a table/list
Check task statuses without downloading full outputs
Build dashboards showing execution statistics

GET

api

flows

{flow_id}

versions

{version}

summary

List task summaries for flow version

curl --request GET \
  --url https://flows.super.ai/api/flows/{flow_id}/versions/{version}/summary \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://flows.super.ai/api/flows/{flow_id}/versions/{version}/summary"

headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-Key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://flows.super.ai/api/flows/{flow_id}/versions/{version}/summary', 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/flows/{flow_id}/versions/{version}/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://flows.super.ai/api/flows/{flow_id}/versions/{version}/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://flows.super.ai/api/flows/{flow_id}/versions/{version}/summary")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/flows/{flow_id}/versions/{version}/summary")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "flow_execution_id": "550e8400-e29b-41d4-a716-446655440000",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modified_by": "<string>",
    "status": "completed",
    "summary": {
      "duration_seconds": 12.5,
      "processed_items": 42
    },
    "task_name": "process_document",
    "updated_at": "2023-11-07T05:31:56Z",
    "flow_version": 3,
    "tags": [
      "priority:high",
      "type:extraction"
    ]
  }
]

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

Path Parameters

flow_id

string<uuid>

required

version

integer

required

Response

List of task summaries successfully retrieved

created_at

string<date-time>

required

flow_execution_id

string<uuid>

required

UUID of the parent flow execution containing this task

Example:

"550e8400-e29b-41d4-a716-446655440000"

string<uuid>

required

modified_by

string

required

status

string

required

Current status of the task execution. Common values: 'running', 'completed', 'failed', 'skipped'

Example:

"completed"

summary

any

required

Task execution summary data. Structure varies by task type. May contain results, metrics, or status information.

Example:

{
  "duration_seconds": 12.5,
  "processed_items": 42
}

task_name

string

required

Name of the task as defined in the flow definition. Case-sensitive.

Required string length: 1 - 255

Example:

"process_document"

updated_at

string<date-time>

required

flow_version

integer | null

Version of the flow definition when this task executed. May differ from current flow version if flow was updated.

Required range: x >= 1

Example:

3

Overview

Endpoints

List task summaries for flow version

Performance Benefits

Use Cases

Authorizations

Path Parameters

Response