Create a new flow - SuperAI Flows
Create a new flow
cURL Example
curl --request POST \
--url https://flows.super.ai/api/flows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"definition": {},
"display_name": "<string>",
"description": "<string>",
"settings": {
"reexecute_on_update": false,
"ttl": {}
},
"visibility": "<unknown>"
}
'```
### Python Example
```python
import requests
url = "https://flows.super.ai/api/flows"
payload = {
"definition": {},
"display_name": "<string>",
"description": "<string>",
"settings": {
"reexecute_on_update": False,
"ttl": {}
},
"visibility": "<unknown>"
}
headers = {
"X-API-Key": "<api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
JavaScript Example
const options = {
method: 'POST',
headers: {
'X-API-Key': '<api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
definition: {},
display_name: '<string>',
description: '<string>',
settings: {reexecute_on_update: false, ttl: {}},
visibility: '<unknown>'
})
};
fetch('https://flows.super.ai/api/flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
PHP Example
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flows.super.ai/api/flows",
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([
'definition' => [],
'display_name' => '<string>',
'description' => '<string>',
'settings' => [
'reexecute_on_update' => false,
'ttl' => []
],
'visibility' => '<unknown>'
]),
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;
}
Go Example
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://flows.super.ai/api/flows"
payload := strings.NewReader("{\n \"definition\": {},\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"reexecute_on_update\": false,\n \"ttl\": {}\n },\n \"visibility\": \"<unknown>\"}\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))
}
Java Example
HttpResponse<String> response = Unirest.post("https://flows.super.ai/api/flows")
.header("X-API-Key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {},\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"reexecute_on_update\": false,\n \"ttl\": {}\n },\n \"visibility\": \"<unknown>\"}\n")
.asString();
Ruby Example
require 'uri'
require 'net/http'
url = URI("https://flows.super.ai/api/flows")
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 \"definition\": {},\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"reexecute_on_update\": false,\n \"ttl\": {}\n },\n \"visibility\": \"<unknown>\"}\n"
response = http.request(request)
puts response.read_body
Example Response
{
"created_at": "2023-11-07T05:31:56Z",
"definition": {},
"display_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_latest": true,
"modified_by": "<string>",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version": 2,
"description": "<string>",
"flow_executions_count": 0,
"settings": {
"reexecute_on_update": false,
"ttl": {}
},
"task_names": [
"<string>"
],
"validation_errors": [
{
"input": "<unknown>",
"loc": [
123
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"url": "<string>"
}
]
}
Authorization Headers
X-API-Key
- Type: String
- Position: Header
- Required: Yes
- Description: 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
- Type: String
- Position: Header
- Required: Yes
- Description: JWT Bearer token authentication. Include your access token in the
Authorization header as: Bearer YOUR_ACCESS_TOKEN
- Example:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Query Parameters
- include_ordered_task_names: boolean, default: false
- Include topologically sorted list of task names in execution order. Useful for visualizing task dependencies.
- include_validation_errors: boolean, default: false
- Include DSL validation errors if the flow definition is malformed. Necessary for debugging invalid flows.
- include_dynamic_data: boolean, default: false
- Include runtime configuration options for each task. Requires authentication to external services.
- include_output_schemas: boolean, default: false
- Include JSON Schema definitions for each task's output structure.
- include_input_schema: boolean, default: false
- Include JSON Schema definitions for input task executors' input.
Request Body
- definition: object, required. The flow definition in DSL format. Must include tasks array, edges array, and version.
- display_name: string, required. Human-readable name for the flow.
- description: string | null, optional. Detailed description of the flow's purpose (markdown supported).
- settings: object | null, flow-level configuration settings.
- visibility: any | null, access control level determining view and execution permission.