curl --request POST \
--url https://flows.super.ai/api/flow-executions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"flow_id": "550e8400-e29b-41d4-a716-446655440000",
"input": {
"file_key": "documents/report.pdf",
"options": {
"language": "en"
}
}
}
'import requests
url = "https://flows.super.ai/api/flow-executions"
payload = {
"flow_id": "550e8400-e29b-41d4-a716-446655440000",
"input": {
"file_key": "documents/report.pdf",
"options": { "language": "en" }
}
}
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_id: '550e8400-e29b-41d4-a716-446655440000',
input: {file_key: 'documents/report.pdf', options: {language: 'en'}}
})
};
fetch('https://flows.super.ai/api/flow-executions', 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",
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_id' => '550e8400-e29b-41d4-a716-446655440000',
'input' => [
'file_key' => 'documents/report.pdf',
'options' => [
'language' => 'en'
]
]
]),
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/flow-executions"
payload := strings.NewReader("{\n \"flow_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"input\": {\n \"file_key\": \"documents/report.pdf\",\n \"options\": {\n \"language\": \"en\"\n }\n }\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/flow-executions")
.header("X-API-Key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"flow_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"input\": {\n \"file_key\": \"documents/report.pdf\",\n \"options\": {\n \"language\": \"en\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flows.super.ai/api/flow-executions")
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_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"input\": {\n \"file_key\": \"documents/report.pdf\",\n \"options\": {\n \"language\": \"en\"\n }\n }\n}"
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"
}Create and start a flow execution
Create a new flow execution and start workflow processing.
This endpoint creates a flow execution record and immediately starts the associated workflow processing. The execution is created with status ‘running’ and will be processed asynchronously by the execution engine.
Context:
- Flow executions represent runtime instances of flow definitions
- Each execution is isolated and maintains its own state
- Input data must conform to the flow’s input schema
- Executions are scoped to the user’s organization
- WebSocket notifications are sent on creation for real-time updates
Execution Flow:
- Validates flow exists and user has access
- Creates execution record in database
- Starts workflow processing asynchronously
- Sends WebSocket notification to connected clients
- Returns immediately (does not wait for completion)
Performance Notes:
- Response time: < 200ms (workflow starts asynchronously)
- Does not block on workflow completion
- WebSocket notifications sent in background task
Use Cases:
- Trigger flow execution from UI dashboard
- Automated flow execution via API integration
- Batch processing of multiple documents
- Event-driven workflow automation
Related Endpoints:
- GET /flow-executions/ - Check execution status
- GET /flow-executions - List all executions for a flow
- POST /flow-executions//execute - Re-execute failed execution
curl --request POST \
--url https://flows.super.ai/api/flow-executions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"flow_id": "550e8400-e29b-41d4-a716-446655440000",
"input": {
"file_key": "documents/report.pdf",
"options": {
"language": "en"
}
}
}
'import requests
url = "https://flows.super.ai/api/flow-executions"
payload = {
"flow_id": "550e8400-e29b-41d4-a716-446655440000",
"input": {
"file_key": "documents/report.pdf",
"options": { "language": "en" }
}
}
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_id: '550e8400-e29b-41d4-a716-446655440000',
input: {file_key: 'documents/report.pdf', options: {language: 'en'}}
})
};
fetch('https://flows.super.ai/api/flow-executions', 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",
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_id' => '550e8400-e29b-41d4-a716-446655440000',
'input' => [
'file_key' => 'documents/report.pdf',
'options' => [
'language' => 'en'
]
]
]),
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/flow-executions"
payload := strings.NewReader("{\n \"flow_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"input\": {\n \"file_key\": \"documents/report.pdf\",\n \"options\": {\n \"language\": \"en\"\n }\n }\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/flow-executions")
.header("X-API-Key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"flow_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"input\": {\n \"file_key\": \"documents/report.pdf\",\n \"options\": {\n \"language\": \"en\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flows.super.ai/api/flow-executions")
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_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"input\": {\n \"file_key\": \"documents/report.pdf\",\n \"options\": {\n \"language\": \"en\"\n }\n }\n}"
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"
}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...
Body
Request payload for creating a new flow execution.
This model defines the required data to start a new flow execution. The input schema must match the flow definition's expected input structure.
UUID of the flow definition to execute. Must be a valid, active flow accessible to your organization. The flow defines the workflow structure and task sequence.
"550e8400-e29b-41d4-a716-446655440000"
Input data for the flow execution. Schema is flow-specific. Common patterns: - Document processing: {'file_key': 'path/to/file.pdf'} - Data processing: {'document_url': 'gs://bucket/file.csv'} - Email processing: {'message_id': 'msg_123', 'attachments': []} Refer to flow definition for exact schema requirements.
{
"file_key": "documents/report.pdf",
"options": { "language": "en" }
}
Response
Flow execution created and started successfully
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"