curl --request PATCH \
--url https://flows.super.ai/api/flow-executions/{flow_execution_id}/status \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <api-key>'import requests
url = "https://flows.super.ai/api/flow-executions/{flow_execution_id}/status"
headers = {
"X-API-Key": "<api-key>",
"Authorization": "Bearer <token>"
}
response = requests.patch(url, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', Authorization: 'Bearer <token>'}
};
fetch('https://flows.super.ai/api/flow-executions/{flow_execution_id}/status', 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/flow-executions/{flow_execution_id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
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/flow-executions/{flow_execution_id}/status"
req, _ := http.NewRequest("PATCH", 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.patch("https://flows.super.ai/api/flow-executions/{flow_execution_id}/status")
.header("X-API-Key", "<api-key>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flows.super.ai/api/flow-executions/{flow_execution_id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.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_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"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Patch Flow Execution Status
Patch the status of a flow execution.
curl --request PATCH \
--url https://flows.super.ai/api/flow-executions/{flow_execution_id}/status \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <api-key>'import requests
url = "https://flows.super.ai/api/flow-executions/{flow_execution_id}/status"
headers = {
"X-API-Key": "<api-key>",
"Authorization": "Bearer <token>"
}
response = requests.patch(url, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', Authorization: 'Bearer <token>'}
};
fetch('https://flows.super.ai/api/flow-executions/{flow_execution_id}/status', 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/flow-executions/{flow_execution_id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
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/flow-executions/{flow_execution_id}/status"
req, _ := http.NewRequest("PATCH", 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.patch("https://flows.super.ai/api/flow-executions/{flow_execution_id}/status")
.header("X-API-Key", "<api-key>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flows.super.ai/api/flow-executions/{flow_execution_id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.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_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"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
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
JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN
Example:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Path Parameters
Query Parameters
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
queued, running, in_progress, completed, failed, deleted, stale, awaiting_input Response
Successful Response
Response model for flow execution operations.
Represents a single flow execution instance with its current state and metadata. Flow executions are runtime instances of flow definitions that process input data through a series of tasks defined in the flow's workflow.
UUID of the flow definition being executed. References the parent flow that defines the workflow structure.
"550e8400-e29b-41d4-a716-446655440000"
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.
x >= 13
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.
{
"file_key": "documents/abc123.pdf",
"metadata": { "priority": "high" }
}
UUID of the organization that owns this execution. Used for access control and data isolation. All executions are scoped to an organization.
"660e8400-e29b-41d4-a716-446655440001"
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.
"running"