Workflows
Create Workflow
Create a multi-step automation workflow.
POST
/
api
/
v1
/
workflows
Create Workflow
curl --request POST \
--url https://api.example.com/api/v1/workflows \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"triggerType": "<string>",
"triggerConfig": {},
"steps": [
{
"type": "<string>",
"name": "<string>",
"config": {},
"onSuccess": 123,
"onFailure": 123
}
],
"enabled": true
}
'import requests
url = "https://api.example.com/api/v1/workflows"
payload = {
"name": "<string>",
"triggerType": "<string>",
"triggerConfig": {},
"steps": [
{
"type": "<string>",
"name": "<string>",
"config": {},
"onSuccess": 123,
"onFailure": 123
}
],
"enabled": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
triggerType: '<string>',
triggerConfig: {},
steps: [
{type: '<string>', name: '<string>', config: {}, onSuccess: 123, onFailure: 123}
],
enabled: true
})
};
fetch('https://api.example.com/api/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/api/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([
'name' => '<string>',
'triggerType' => '<string>',
'triggerConfig' => [
],
'steps' => [
[
'type' => '<string>',
'name' => '<string>',
'config' => [
],
'onSuccess' => 123,
'onFailure' => 123
]
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"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/api/v1/workflows"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"triggerType\": \"<string>\",\n \"triggerConfig\": {},\n \"steps\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {},\n \"onSuccess\": 123,\n \"onFailure\": 123\n }\n ],\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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/api/v1/workflows")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"triggerType\": \"<string>\",\n \"triggerConfig\": {},\n \"steps\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {},\n \"onSuccess\": 123,\n \"onFailure\": 123\n }\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"triggerType\": \"<string>\",\n \"triggerConfig\": {},\n \"steps\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {},\n \"onSuccess\": 123,\n \"onFailure\": 123\n }\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"workflow": {}
}Create a workflow that chains AI tasks together with scheduling, event triggers, and conditional logic.
Authentication
Requires a Bearer token. See Authentication.Request Body
Human-readable workflow name.
How the workflow is triggered. One of:
schedule, event, manual.Trigger-specific configuration (e.g.,
{ "cron": "0 9 * * 1" } for schedule triggers).Ordered array of workflow steps. At least one step is required.
Whether the workflow is active.
Request Examples
curl -X POST https://www.hitheo.ai/api/v1/workflows \
-H "Authorization: Bearer $THEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Weekly Pipeline Report",
"triggerType": "schedule",
"triggerConfig": { "cron": "0 9 * * 1" },
"steps": [
{
"type": "ai_transform",
"name": "Generate report",
"config": { "prompt": "Analyze this week's pipeline changes", "skills": ["data-extraction"] }
},
{
"type": "notification",
"name": "Send to team",
"config": { "channel": "email", "to": "team@acme.com" }
}
]
}'
const workflow = await theo.createWorkflow({
name: "Weekly Pipeline Report",
triggerType: "schedule",
triggerConfig: { cron: "0 9 * * 1" },
steps: [
{
type: "ai_transform",
name: "Generate report",
config: { prompt: "Analyze this week's pipeline changes", skills: ["data-extraction"] },
},
{
type: "notification",
name: "Send to team",
config: { channel: "email", to: "team@acme.com" },
},
],
});
Response (HTTP 201)
The created workflow object with generated
id and timestamps.Errors
| Status | Code | Description |
|---|---|---|
| 400 | missing_fields | name, triggerType, and steps are required |
Endpoint
POST /api/v1/workflows
Requires authentication via Bearer token. See Authentication.Was this page helpful?
⌘I
Create Workflow
curl --request POST \
--url https://api.example.com/api/v1/workflows \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"triggerType": "<string>",
"triggerConfig": {},
"steps": [
{
"type": "<string>",
"name": "<string>",
"config": {},
"onSuccess": 123,
"onFailure": 123
}
],
"enabled": true
}
'import requests
url = "https://api.example.com/api/v1/workflows"
payload = {
"name": "<string>",
"triggerType": "<string>",
"triggerConfig": {},
"steps": [
{
"type": "<string>",
"name": "<string>",
"config": {},
"onSuccess": 123,
"onFailure": 123
}
],
"enabled": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
triggerType: '<string>',
triggerConfig: {},
steps: [
{type: '<string>', name: '<string>', config: {}, onSuccess: 123, onFailure: 123}
],
enabled: true
})
};
fetch('https://api.example.com/api/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/api/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([
'name' => '<string>',
'triggerType' => '<string>',
'triggerConfig' => [
],
'steps' => [
[
'type' => '<string>',
'name' => '<string>',
'config' => [
],
'onSuccess' => 123,
'onFailure' => 123
]
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"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/api/v1/workflows"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"triggerType\": \"<string>\",\n \"triggerConfig\": {},\n \"steps\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {},\n \"onSuccess\": 123,\n \"onFailure\": 123\n }\n ],\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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/api/v1/workflows")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"triggerType\": \"<string>\",\n \"triggerConfig\": {},\n \"steps\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {},\n \"onSuccess\": 123,\n \"onFailure\": 123\n }\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"triggerType\": \"<string>\",\n \"triggerConfig\": {},\n \"steps\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {},\n \"onSuccess\": 123,\n \"onFailure\": 123\n }\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"workflow": {}
}