Create a workflow
curl --request POST \
--url https://inference.studio.lyzr.ai/api/workflows \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"flow_id": "<string>",
"flow_name": "Document Processing Flow",
"flow_data": {
"name": "Minimal Example",
"nodes": [
{
"id": "a1b2c3d4-0000-0000-0000-000000000001",
"name": "Trigger",
"type": "lyzr-nodes-base.trigger",
"typeVersion": 1,
"parameters": {},
"position": [
240,
300
]
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000002",
"name": "Set",
"type": "lyzr-nodes-base.set",
"typeVersion": 3.4,
"parameters": {
"assignments": {
"assignments": [
{
"id": "f1",
"name": "greeting",
"type": "string",
"value": "=Hello {{ $json.name }}"
}
]
}
},
"position": [
480,
300
]
}
],
"connections": {
"Trigger": {
"main": [
[
{
"node": "Set",
"type": "main",
"index": 0
}
]
]
}
},
"settings": {}
},
"version": 123,
"is_owner": true,
"user_id": "<string>",
"org_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
'import requests
url = "https://inference.studio.lyzr.ai/api/workflows"
payload = {
"flow_id": "<string>",
"flow_name": "Document Processing Flow",
"flow_data": {
"name": "Minimal Example",
"nodes": [
{
"id": "a1b2c3d4-0000-0000-0000-000000000001",
"name": "Trigger",
"type": "lyzr-nodes-base.trigger",
"typeVersion": 1,
"parameters": {},
"position": [240, 300]
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000002",
"name": "Set",
"type": "lyzr-nodes-base.set",
"typeVersion": 3.4,
"parameters": { "assignments": { "assignments": [
{
"id": "f1",
"name": "greeting",
"type": "string",
"value": "=Hello {{ $json.name }}"
}
] } },
"position": [480, 300]
}
],
"connections": { "Trigger": { "main": [[
{
"node": "Set",
"type": "main",
"index": 0
}
]] } },
"settings": {}
},
"version": 123,
"is_owner": True,
"user_id": "<string>",
"org_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"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>', 'Content-Type': 'application/json'},
body: JSON.stringify({
flow_id: '<string>',
flow_name: 'Document Processing Flow',
flow_data: {
name: 'Minimal Example',
nodes: [
{
id: 'a1b2c3d4-0000-0000-0000-000000000001',
name: 'Trigger',
type: 'lyzr-nodes-base.trigger',
typeVersion: 1,
parameters: {},
position: [240, 300]
},
{
id: 'a1b2c3d4-0000-0000-0000-000000000002',
name: 'Set',
type: 'lyzr-nodes-base.set',
typeVersion: 3.4,
parameters: {
assignments: {
assignments: [{id: 'f1', name: 'greeting', type: 'string', value: '=Hello {{ $json.name }}'}]
}
},
position: [480, 300]
}
],
connections: {Trigger: {main: [[{node: 'Set', type: 'main', index: 0}]]}},
settings: {}
},
version: 123,
is_owner: true,
user_id: '<string>',
org_id: '<string>',
created_at: '<string>',
updated_at: '<string>'
})
};
fetch('https://inference.studio.lyzr.ai/api/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://inference.studio.lyzr.ai/api/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([
'flow_id' => '<string>',
'flow_name' => 'Document Processing Flow',
'flow_data' => [
'name' => 'Minimal Example',
'nodes' => [
[
'id' => 'a1b2c3d4-0000-0000-0000-000000000001',
'name' => 'Trigger',
'type' => 'lyzr-nodes-base.trigger',
'typeVersion' => 1,
'parameters' => [
],
'position' => [
240,
300
]
],
[
'id' => 'a1b2c3d4-0000-0000-0000-000000000002',
'name' => 'Set',
'type' => 'lyzr-nodes-base.set',
'typeVersion' => 3.4,
'parameters' => [
'assignments' => [
'assignments' => [
[
'id' => 'f1',
'name' => 'greeting',
'type' => 'string',
'value' => '=Hello {{ $json.name }}'
]
]
]
],
'position' => [
480,
300
]
]
],
'connections' => [
'Trigger' => [
'main' => [
[
[
'node' => 'Set',
'type' => 'main',
'index' => 0
]
]
]
]
],
'settings' => [
]
],
'version' => 123,
'is_owner' => true,
'user_id' => '<string>',
'org_id' => '<string>',
'created_at' => '<string>',
'updated_at' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://inference.studio.lyzr.ai/api/workflows"
payload := strings.NewReader("{\n \"flow_id\": \"<string>\",\n \"flow_name\": \"Document Processing Flow\",\n \"flow_data\": {\n \"name\": \"Minimal Example\",\n \"nodes\": [\n {\n \"id\": \"a1b2c3d4-0000-0000-0000-000000000001\",\n \"name\": \"Trigger\",\n \"type\": \"lyzr-nodes-base.trigger\",\n \"typeVersion\": 1,\n \"parameters\": {},\n \"position\": [\n 240,\n 300\n ]\n },\n {\n \"id\": \"a1b2c3d4-0000-0000-0000-000000000002\",\n \"name\": \"Set\",\n \"type\": \"lyzr-nodes-base.set\",\n \"typeVersion\": 3.4,\n \"parameters\": {\n \"assignments\": {\n \"assignments\": [\n {\n \"id\": \"f1\",\n \"name\": \"greeting\",\n \"type\": \"string\",\n \"value\": \"=Hello {{ $json.name }}\"\n }\n ]\n }\n },\n \"position\": [\n 480,\n 300\n ]\n }\n ],\n \"connections\": {\n \"Trigger\": {\n \"main\": [\n [\n {\n \"node\": \"Set\",\n \"type\": \"main\",\n \"index\": 0\n }\n ]\n ]\n }\n },\n \"settings\": {}\n },\n \"version\": 123,\n \"is_owner\": true,\n \"user_id\": \"<string>\",\n \"org_id\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://inference.studio.lyzr.ai/api/workflows")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"flow_id\": \"<string>\",\n \"flow_name\": \"Document Processing Flow\",\n \"flow_data\": {\n \"name\": \"Minimal Example\",\n \"nodes\": [\n {\n \"id\": \"a1b2c3d4-0000-0000-0000-000000000001\",\n \"name\": \"Trigger\",\n \"type\": \"lyzr-nodes-base.trigger\",\n \"typeVersion\": 1,\n \"parameters\": {},\n \"position\": [\n 240,\n 300\n ]\n },\n {\n \"id\": \"a1b2c3d4-0000-0000-0000-000000000002\",\n \"name\": \"Set\",\n \"type\": \"lyzr-nodes-base.set\",\n \"typeVersion\": 3.4,\n \"parameters\": {\n \"assignments\": {\n \"assignments\": [\n {\n \"id\": \"f1\",\n \"name\": \"greeting\",\n \"type\": \"string\",\n \"value\": \"=Hello {{ $json.name }}\"\n }\n ]\n }\n },\n \"position\": [\n 480,\n 300\n ]\n }\n ],\n \"connections\": {\n \"Trigger\": {\n \"main\": [\n [\n {\n \"node\": \"Set\",\n \"type\": \"main\",\n \"index\": 0\n }\n ]\n ]\n }\n },\n \"settings\": {}\n },\n \"version\": 123,\n \"is_owner\": true,\n \"user_id\": \"<string>\",\n \"org_id\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://inference.studio.lyzr.ai/api/workflows")
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["Content-Type"] = 'application/json'
request.body = "{\n \"flow_id\": \"<string>\",\n \"flow_name\": \"Document Processing Flow\",\n \"flow_data\": {\n \"name\": \"Minimal Example\",\n \"nodes\": [\n {\n \"id\": \"a1b2c3d4-0000-0000-0000-000000000001\",\n \"name\": \"Trigger\",\n \"type\": \"lyzr-nodes-base.trigger\",\n \"typeVersion\": 1,\n \"parameters\": {},\n \"position\": [\n 240,\n 300\n ]\n },\n {\n \"id\": \"a1b2c3d4-0000-0000-0000-000000000002\",\n \"name\": \"Set\",\n \"type\": \"lyzr-nodes-base.set\",\n \"typeVersion\": 3.4,\n \"parameters\": {\n \"assignments\": {\n \"assignments\": [\n {\n \"id\": \"f1\",\n \"name\": \"greeting\",\n \"type\": \"string\",\n \"value\": \"=Hello {{ $json.name }}\"\n }\n ]\n }\n },\n \"position\": [\n 480,\n 300\n ]\n }\n ],\n \"connections\": {\n \"Trigger\": {\n \"main\": [\n [\n {\n \"node\": \"Set\",\n \"type\": \"main\",\n \"index\": 0\n }\n ]\n ]\n }\n },\n \"settings\": {}\n },\n \"version\": 123,\n \"is_owner\": true,\n \"user_id\": \"<string>\",\n \"org_id\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"flow_id": "wf_9f2c1a"
}{
"error": "<string>"
}{
"error": "<string>"
}Workflows
Create Workflow
Stores a workflow definition. The caller becomes the owner, and a private sharing group is registered upstream so the resource is visible to the RBAC layer. Only flow_name and flow_data are required from the caller.
POST
/
workflows
Create a workflow
curl --request POST \
--url https://inference.studio.lyzr.ai/api/workflows \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"flow_id": "<string>",
"flow_name": "Document Processing Flow",
"flow_data": {
"name": "Minimal Example",
"nodes": [
{
"id": "a1b2c3d4-0000-0000-0000-000000000001",
"name": "Trigger",
"type": "lyzr-nodes-base.trigger",
"typeVersion": 1,
"parameters": {},
"position": [
240,
300
]
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000002",
"name": "Set",
"type": "lyzr-nodes-base.set",
"typeVersion": 3.4,
"parameters": {
"assignments": {
"assignments": [
{
"id": "f1",
"name": "greeting",
"type": "string",
"value": "=Hello {{ $json.name }}"
}
]
}
},
"position": [
480,
300
]
}
],
"connections": {
"Trigger": {
"main": [
[
{
"node": "Set",
"type": "main",
"index": 0
}
]
]
}
},
"settings": {}
},
"version": 123,
"is_owner": true,
"user_id": "<string>",
"org_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
'import requests
url = "https://inference.studio.lyzr.ai/api/workflows"
payload = {
"flow_id": "<string>",
"flow_name": "Document Processing Flow",
"flow_data": {
"name": "Minimal Example",
"nodes": [
{
"id": "a1b2c3d4-0000-0000-0000-000000000001",
"name": "Trigger",
"type": "lyzr-nodes-base.trigger",
"typeVersion": 1,
"parameters": {},
"position": [240, 300]
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000002",
"name": "Set",
"type": "lyzr-nodes-base.set",
"typeVersion": 3.4,
"parameters": { "assignments": { "assignments": [
{
"id": "f1",
"name": "greeting",
"type": "string",
"value": "=Hello {{ $json.name }}"
}
] } },
"position": [480, 300]
}
],
"connections": { "Trigger": { "main": [[
{
"node": "Set",
"type": "main",
"index": 0
}
]] } },
"settings": {}
},
"version": 123,
"is_owner": True,
"user_id": "<string>",
"org_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"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>', 'Content-Type': 'application/json'},
body: JSON.stringify({
flow_id: '<string>',
flow_name: 'Document Processing Flow',
flow_data: {
name: 'Minimal Example',
nodes: [
{
id: 'a1b2c3d4-0000-0000-0000-000000000001',
name: 'Trigger',
type: 'lyzr-nodes-base.trigger',
typeVersion: 1,
parameters: {},
position: [240, 300]
},
{
id: 'a1b2c3d4-0000-0000-0000-000000000002',
name: 'Set',
type: 'lyzr-nodes-base.set',
typeVersion: 3.4,
parameters: {
assignments: {
assignments: [{id: 'f1', name: 'greeting', type: 'string', value: '=Hello {{ $json.name }}'}]
}
},
position: [480, 300]
}
],
connections: {Trigger: {main: [[{node: 'Set', type: 'main', index: 0}]]}},
settings: {}
},
version: 123,
is_owner: true,
user_id: '<string>',
org_id: '<string>',
created_at: '<string>',
updated_at: '<string>'
})
};
fetch('https://inference.studio.lyzr.ai/api/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://inference.studio.lyzr.ai/api/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([
'flow_id' => '<string>',
'flow_name' => 'Document Processing Flow',
'flow_data' => [
'name' => 'Minimal Example',
'nodes' => [
[
'id' => 'a1b2c3d4-0000-0000-0000-000000000001',
'name' => 'Trigger',
'type' => 'lyzr-nodes-base.trigger',
'typeVersion' => 1,
'parameters' => [
],
'position' => [
240,
300
]
],
[
'id' => 'a1b2c3d4-0000-0000-0000-000000000002',
'name' => 'Set',
'type' => 'lyzr-nodes-base.set',
'typeVersion' => 3.4,
'parameters' => [
'assignments' => [
'assignments' => [
[
'id' => 'f1',
'name' => 'greeting',
'type' => 'string',
'value' => '=Hello {{ $json.name }}'
]
]
]
],
'position' => [
480,
300
]
]
],
'connections' => [
'Trigger' => [
'main' => [
[
[
'node' => 'Set',
'type' => 'main',
'index' => 0
]
]
]
]
],
'settings' => [
]
],
'version' => 123,
'is_owner' => true,
'user_id' => '<string>',
'org_id' => '<string>',
'created_at' => '<string>',
'updated_at' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://inference.studio.lyzr.ai/api/workflows"
payload := strings.NewReader("{\n \"flow_id\": \"<string>\",\n \"flow_name\": \"Document Processing Flow\",\n \"flow_data\": {\n \"name\": \"Minimal Example\",\n \"nodes\": [\n {\n \"id\": \"a1b2c3d4-0000-0000-0000-000000000001\",\n \"name\": \"Trigger\",\n \"type\": \"lyzr-nodes-base.trigger\",\n \"typeVersion\": 1,\n \"parameters\": {},\n \"position\": [\n 240,\n 300\n ]\n },\n {\n \"id\": \"a1b2c3d4-0000-0000-0000-000000000002\",\n \"name\": \"Set\",\n \"type\": \"lyzr-nodes-base.set\",\n \"typeVersion\": 3.4,\n \"parameters\": {\n \"assignments\": {\n \"assignments\": [\n {\n \"id\": \"f1\",\n \"name\": \"greeting\",\n \"type\": \"string\",\n \"value\": \"=Hello {{ $json.name }}\"\n }\n ]\n }\n },\n \"position\": [\n 480,\n 300\n ]\n }\n ],\n \"connections\": {\n \"Trigger\": {\n \"main\": [\n [\n {\n \"node\": \"Set\",\n \"type\": \"main\",\n \"index\": 0\n }\n ]\n ]\n }\n },\n \"settings\": {}\n },\n \"version\": 123,\n \"is_owner\": true,\n \"user_id\": \"<string>\",\n \"org_id\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://inference.studio.lyzr.ai/api/workflows")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"flow_id\": \"<string>\",\n \"flow_name\": \"Document Processing Flow\",\n \"flow_data\": {\n \"name\": \"Minimal Example\",\n \"nodes\": [\n {\n \"id\": \"a1b2c3d4-0000-0000-0000-000000000001\",\n \"name\": \"Trigger\",\n \"type\": \"lyzr-nodes-base.trigger\",\n \"typeVersion\": 1,\n \"parameters\": {},\n \"position\": [\n 240,\n 300\n ]\n },\n {\n \"id\": \"a1b2c3d4-0000-0000-0000-000000000002\",\n \"name\": \"Set\",\n \"type\": \"lyzr-nodes-base.set\",\n \"typeVersion\": 3.4,\n \"parameters\": {\n \"assignments\": {\n \"assignments\": [\n {\n \"id\": \"f1\",\n \"name\": \"greeting\",\n \"type\": \"string\",\n \"value\": \"=Hello {{ $json.name }}\"\n }\n ]\n }\n },\n \"position\": [\n 480,\n 300\n ]\n }\n ],\n \"connections\": {\n \"Trigger\": {\n \"main\": [\n [\n {\n \"node\": \"Set\",\n \"type\": \"main\",\n \"index\": 0\n }\n ]\n ]\n }\n },\n \"settings\": {}\n },\n \"version\": 123,\n \"is_owner\": true,\n \"user_id\": \"<string>\",\n \"org_id\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://inference.studio.lyzr.ai/api/workflows")
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["Content-Type"] = 'application/json'
request.body = "{\n \"flow_id\": \"<string>\",\n \"flow_name\": \"Document Processing Flow\",\n \"flow_data\": {\n \"name\": \"Minimal Example\",\n \"nodes\": [\n {\n \"id\": \"a1b2c3d4-0000-0000-0000-000000000001\",\n \"name\": \"Trigger\",\n \"type\": \"lyzr-nodes-base.trigger\",\n \"typeVersion\": 1,\n \"parameters\": {},\n \"position\": [\n 240,\n 300\n ]\n },\n {\n \"id\": \"a1b2c3d4-0000-0000-0000-000000000002\",\n \"name\": \"Set\",\n \"type\": \"lyzr-nodes-base.set\",\n \"typeVersion\": 3.4,\n \"parameters\": {\n \"assignments\": {\n \"assignments\": [\n {\n \"id\": \"f1\",\n \"name\": \"greeting\",\n \"type\": \"string\",\n \"value\": \"=Hello {{ $json.name }}\"\n }\n ]\n }\n },\n \"position\": [\n 480,\n 300\n ]\n }\n ],\n \"connections\": {\n \"Trigger\": {\n \"main\": [\n [\n {\n \"node\": \"Set\",\n \"type\": \"main\",\n \"index\": 0\n }\n ]\n ]\n }\n },\n \"settings\": {}\n },\n \"version\": 123,\n \"is_owner\": true,\n \"user_id\": \"<string>\",\n \"org_id\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"flow_id": "wf_9f2c1a"
}{
"error": "<string>"
}{
"error": "<string>"
}Only
flow_name and flow_data are required in the request body. The full structure of the flow_data document, including connections and expression syntax, is described in the flow_data reference, and every node type is documented in the node types reference.Authorizations
Tenant API key. Required on every endpoint.
Body
application/json
Workflow definition. Only flow_name and flow_data are required.
Example:
"Document Processing Flow"
Workflow graph definition as JSON (nodes, connections, and node configuration). See the flow_data reference for the full structure and the node types reference for every node type.
Example:
{
"name": "Minimal Example",
"nodes": [
{
"id": "a1b2c3d4-0000-0000-0000-000000000001",
"name": "Trigger",
"type": "lyzr-nodes-base.trigger",
"typeVersion": 1,
"parameters": {},
"position": [240, 300]
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000002",
"name": "Set",
"type": "lyzr-nodes-base.set",
"typeVersion": 3.4,
"parameters": {
"assignments": {
"assignments": [
{
"id": "f1",
"name": "greeting",
"type": "string",
"value": "=Hello {{ $json.name }}"
}
]
}
},
"position": [480, 300]
}
],
"connections": {
"Trigger": {
"main": [
[
{ "node": "Set", "type": "main", "index": 0 }
]
]
}
},
"settings": {}
}
Computed per response so the UI can distinguish owned rows from shared rows without seeing the owner's key. Not persisted.
Response
Created
Example:
"wf_9f2c1a"
⌘I