List flow executions with filtering and pagination - SuperAI Flows

List flow executions with filtering and pagination

cURL

curl --request GET \
  --url 'https://flows.super.ai/api/flow-executions?page=1&page_size=10' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

Python

import requests

url = "https://flows.super.ai/api/flow-executions?page=1&page_size=10"

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

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

print(response.text)

JavaScript (Fetch)

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

fetch('https://flows.super.ai/api/flow-executions?page=1&page_size=10', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flows.super.ai/api/flow-executions?page=1&page_size=10",
  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;
}
?>

Go

package main

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

func main() {

url := "https://flows.super.ai/api/flow-executions?page=1&page_size=10"

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))
}

Unirest

HttpResponse<String> response = Unirest.get("https://flows.super.ai/api/flow-executions?page=1&page_size=10")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/flow-executions?page=1&page_size=10")

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

Example Response

[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "flow_id": "550e8400-e29b-41d4-a716-446655440000",
    "flow_version": 3,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "input": {
      "file_key": "documents/abc123.pdf",
      "metadata": {
        "priority": "high"
      }
    },
    "modified_by": "<string>",
    "organization_id": "660e8400-e29b-41d4-a716-446655440001",
    "status": "running",
    "updated_at": "2023-11-07T05:31:56Z",
    "run_number": 42
  }
]

Authorizations

X-API-Key

• Type: string
• Location: header
• Required: Yes

Include your API key in the X-API-Key header.

Authorization

• Type: string
• Location: header
• Required: Yes

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

Query Parameters

• flow_id: string (required)
• sort_field: string | null
• sort_direction: string | null
• status: string[] | null
• tags: string[] | null
• include_run_number: boolean (default: false)
• page: integer (default: 1)
• page_size: integer (default: 10)
• start_from_execution_id: string | null

Response Format

200

Content-Type: application/json Body:

• created_at: string
• flow_id: string
• flow_version: integer
• id: string
• input: Input object
• modified_by: string
• organization_id: string
• status: string
• updated_at: string
• run_number: integer | null