Create workflow
curl --request POST \
--url https://api.example.com/v1/workflows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "<string>",
"title": "<string>",
"description": "",
"status": "draft",
"output_folder": "",
"graph": {},
"triggers": [
{
"schedule": {
"zone_id": "<string>",
"time_of_day": "09:00",
"run_date": "2023-12-25",
"days_of_week": [],
"day_of_month": 16,
"interval": 1
},
"id": "",
"type": "schedule",
"label": "",
"enabled": true,
"params": {}
}
]
}
'import requests
url = "https://api.example.com/v1/workflows"
payload = {
"project_id": "<string>",
"title": "<string>",
"description": "",
"status": "draft",
"output_folder": "",
"graph": {},
"triggers": [
{
"schedule": {
"zone_id": "<string>",
"time_of_day": "09:00",
"run_date": "2023-12-25",
"days_of_week": [],
"day_of_month": 16,
"interval": 1
},
"id": "",
"type": "schedule",
"label": "",
"enabled": True,
"params": {}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
project_id: '<string>',
title: '<string>',
description: '',
status: 'draft',
output_folder: '',
graph: {},
triggers: [
{
schedule: {
zone_id: '<string>',
time_of_day: '09:00',
run_date: '2023-12-25',
days_of_week: [],
day_of_month: 16,
interval: 1
},
id: '',
type: 'schedule',
label: '',
enabled: true,
params: {}
}
]
})
};
fetch('https://api.example.com/v1/workflows', 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://api.example.com/v1/workflows",
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([
'project_id' => '<string>',
'title' => '<string>',
'description' => '',
'status' => 'draft',
'output_folder' => '',
'graph' => [
],
'triggers' => [
[
'schedule' => [
'zone_id' => '<string>',
'time_of_day' => '09:00',
'run_date' => '2023-12-25',
'days_of_week' => [
],
'day_of_month' => 16,
'interval' => 1
],
'id' => '',
'type' => 'schedule',
'label' => '',
'enabled' => true,
'params' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.example.com/v1/workflows"
payload := strings.NewReader("{\n \"project_id\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"\",\n \"status\": \"draft\",\n \"output_folder\": \"\",\n \"graph\": {},\n \"triggers\": [\n {\n \"schedule\": {\n \"zone_id\": \"<string>\",\n \"time_of_day\": \"09:00\",\n \"run_date\": \"2023-12-25\",\n \"days_of_week\": [],\n \"day_of_month\": 16,\n \"interval\": 1\n },\n \"id\": \"\",\n \"type\": \"schedule\",\n \"label\": \"\",\n \"enabled\": true,\n \"params\": {}\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/v1/workflows")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"\",\n \"status\": \"draft\",\n \"output_folder\": \"\",\n \"graph\": {},\n \"triggers\": [\n {\n \"schedule\": {\n \"zone_id\": \"<string>\",\n \"time_of_day\": \"09:00\",\n \"run_date\": \"2023-12-25\",\n \"days_of_week\": [],\n \"day_of_month\": 16,\n \"interval\": 1\n },\n \"id\": \"\",\n \"type\": \"schedule\",\n \"label\": \"\",\n \"enabled\": true,\n \"params\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_id\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"\",\n \"status\": \"draft\",\n \"output_folder\": \"\",\n \"graph\": {},\n \"triggers\": [\n {\n \"schedule\": {\n \"zone_id\": \"<string>\",\n \"time_of_day\": \"09:00\",\n \"run_date\": \"2023-12-25\",\n \"days_of_week\": [],\n \"day_of_month\": 16,\n \"interval\": 1\n },\n \"id\": \"\",\n \"type\": \"schedule\",\n \"label\": \"\",\n \"enabled\": true,\n \"params\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"projectId": "<string>",
"title": "<string>",
"description": "<string>",
"ownerUserId": "<string>",
"status": "<string>",
"executionFormat": "<string>",
"outputFolder": "<string>",
"revision": 123,
"activeVersionId": "<string>",
"triggers": [
{
"id": "<string>",
"type": "<string>",
"label": "<string>",
"enabled": true,
"params": {},
"schedule": {
"type": "<string>",
"zoneId": "<string>",
"cronExpression": "<string>",
"everyMinutes": 123,
"timeOfDay": "<string>",
"runDate": "<string>",
"anchorDate": "<string>",
"daysOfWeek": [
"<string>"
],
"dayOfMonth": 123,
"interval": 123
}
}
],
"steps": [
{
"id": "<string>",
"position": 123,
"type": "<string>",
"targetFileId": "<string>",
"config": {},
"targets": [
{
"kind": "email_to",
"value": "<string>",
"displayName": "<string>"
}
]
}
],
"graph": {},
"createdAt": "<string>",
"updatedAt": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}Workflows
Create workflow
Create a workflow in a project you can edit. The workflow is created as a draft and runs nothing until you activate it. You become its owner, and its runs execute as you.
POST
/
v1
/
workflows
Create workflow
curl --request POST \
--url https://api.example.com/v1/workflows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "<string>",
"title": "<string>",
"description": "",
"status": "draft",
"output_folder": "",
"graph": {},
"triggers": [
{
"schedule": {
"zone_id": "<string>",
"time_of_day": "09:00",
"run_date": "2023-12-25",
"days_of_week": [],
"day_of_month": 16,
"interval": 1
},
"id": "",
"type": "schedule",
"label": "",
"enabled": true,
"params": {}
}
]
}
'import requests
url = "https://api.example.com/v1/workflows"
payload = {
"project_id": "<string>",
"title": "<string>",
"description": "",
"status": "draft",
"output_folder": "",
"graph": {},
"triggers": [
{
"schedule": {
"zone_id": "<string>",
"time_of_day": "09:00",
"run_date": "2023-12-25",
"days_of_week": [],
"day_of_month": 16,
"interval": 1
},
"id": "",
"type": "schedule",
"label": "",
"enabled": True,
"params": {}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
project_id: '<string>',
title: '<string>',
description: '',
status: 'draft',
output_folder: '',
graph: {},
triggers: [
{
schedule: {
zone_id: '<string>',
time_of_day: '09:00',
run_date: '2023-12-25',
days_of_week: [],
day_of_month: 16,
interval: 1
},
id: '',
type: 'schedule',
label: '',
enabled: true,
params: {}
}
]
})
};
fetch('https://api.example.com/v1/workflows', 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://api.example.com/v1/workflows",
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([
'project_id' => '<string>',
'title' => '<string>',
'description' => '',
'status' => 'draft',
'output_folder' => '',
'graph' => [
],
'triggers' => [
[
'schedule' => [
'zone_id' => '<string>',
'time_of_day' => '09:00',
'run_date' => '2023-12-25',
'days_of_week' => [
],
'day_of_month' => 16,
'interval' => 1
],
'id' => '',
'type' => 'schedule',
'label' => '',
'enabled' => true,
'params' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.example.com/v1/workflows"
payload := strings.NewReader("{\n \"project_id\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"\",\n \"status\": \"draft\",\n \"output_folder\": \"\",\n \"graph\": {},\n \"triggers\": [\n {\n \"schedule\": {\n \"zone_id\": \"<string>\",\n \"time_of_day\": \"09:00\",\n \"run_date\": \"2023-12-25\",\n \"days_of_week\": [],\n \"day_of_month\": 16,\n \"interval\": 1\n },\n \"id\": \"\",\n \"type\": \"schedule\",\n \"label\": \"\",\n \"enabled\": true,\n \"params\": {}\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/v1/workflows")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"\",\n \"status\": \"draft\",\n \"output_folder\": \"\",\n \"graph\": {},\n \"triggers\": [\n {\n \"schedule\": {\n \"zone_id\": \"<string>\",\n \"time_of_day\": \"09:00\",\n \"run_date\": \"2023-12-25\",\n \"days_of_week\": [],\n \"day_of_month\": 16,\n \"interval\": 1\n },\n \"id\": \"\",\n \"type\": \"schedule\",\n \"label\": \"\",\n \"enabled\": true,\n \"params\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_id\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"\",\n \"status\": \"draft\",\n \"output_folder\": \"\",\n \"graph\": {},\n \"triggers\": [\n {\n \"schedule\": {\n \"zone_id\": \"<string>\",\n \"time_of_day\": \"09:00\",\n \"run_date\": \"2023-12-25\",\n \"days_of_week\": [],\n \"day_of_month\": 16,\n \"interval\": 1\n },\n \"id\": \"\",\n \"type\": \"schedule\",\n \"label\": \"\",\n \"enabled\": true,\n \"params\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"projectId": "<string>",
"title": "<string>",
"description": "<string>",
"ownerUserId": "<string>",
"status": "<string>",
"executionFormat": "<string>",
"outputFolder": "<string>",
"revision": 123,
"activeVersionId": "<string>",
"triggers": [
{
"id": "<string>",
"type": "<string>",
"label": "<string>",
"enabled": true,
"params": {},
"schedule": {
"type": "<string>",
"zoneId": "<string>",
"cronExpression": "<string>",
"everyMinutes": 123,
"timeOfDay": "<string>",
"runDate": "<string>",
"anchorDate": "<string>",
"daysOfWeek": [
"<string>"
],
"dayOfMonth": 123,
"interval": 123
}
}
],
"steps": [
{
"id": "<string>",
"position": 123,
"type": "<string>",
"targetFileId": "<string>",
"config": {},
"targets": [
{
"kind": "email_to",
"value": "<string>",
"displayName": "<string>"
}
]
}
],
"graph": {},
"createdAt": "<string>",
"updatedAt": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
A new workflow. Created as a draft; use the activate operation to make it run.
Project the workflow belongs to. You must have editor access to it.
Minimum string length:
1Workflow name, shown wherever it is listed.
Required string length:
1 - 255Optional longer description.
Maximum string length:
2000Workflow state. A workflow becomes active only through the activate operation, which freezes the version that runs.
Available options:
draft, paused, archived Project folder the workflow writes its outputs to, for example /Reports.
Maximum string length:
512The workflow's graph document: the nodes it runs and how they connect, as {"nodes": [...], "edges": [...]}. This is the FULL desired document on every create and update, not a patch — what you send replaces the stored graph. It must contain a trigger node, summation.trigger.schedule/v1 or summation.trigger.manual/v1, wired to the first work node by an edge {"from_node": "", "from_port": "inputs", "to_node": "", "to_port": "inputs"}. Each node is {"key", "type", "config"}; the node type ids you may use and the config each one takes come from GET /v1/workflows/node-types. A config carries ONLY the keys its node type declares there — any other key is refused, so a field the node type does not name cannot be smuggled through it. Use the summation.trigger.schedule/v1 node exactly when this request also carries schedule triggers; see the triggers field. Omit to create an empty draft. Serializes to at most 200000 characters. The web editor adopts API-authored graphs and normalizes them to its canonical form on its next save.
Schedules that start this workflow. Omit for a workflow that only runs on demand. These rows and the graph's trigger nodes must agree: a schedule here requires a summation.trigger.schedule/v1 node in the graph — it is the node the schedule's parameter values are bound to — and that node requires a schedule here, or nothing would fire it. A request where the two disagree is refused.
Maximum array length:
20Show child attributes
Show child attributes
Response
Successful Response
Show child attributes
Show child attributes