Run Workflow

curl --request POST \
  --url https://app.splox.io/api/v1/workflow-requests/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflow_version_id": "0199e001-a23b-7c8d-1234-567890abcdef",
  "chat_id": "0199f200-a11b-7c8d-4444-888890abcdef",
  "entry_node_ids": [
    "0199e002-b34c-8d9e-2345-678901bcdef0"
  ],
  "query": "Summarize the latest sales report",
  "files": []
}
'

import requests

url = "https://app.splox.io/api/v1/workflow-requests/run"

payload = {
    "workflow_version_id": "0199e001-a23b-7c8d-1234-567890abcdef",
    "chat_id": "0199f200-a11b-7c8d-4444-888890abcdef",
    "entry_node_ids": ["0199e002-b34c-8d9e-2345-678901bcdef0"],
    "query": "Summarize the latest sales report",
    "files": []
}
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({
    workflow_version_id: '0199e001-a23b-7c8d-1234-567890abcdef',
    chat_id: '0199f200-a11b-7c8d-4444-888890abcdef',
    entry_node_ids: ['0199e002-b34c-8d9e-2345-678901bcdef0'],
    query: 'Summarize the latest sales report',
    files: []
  })
};

fetch('https://app.splox.io/api/v1/workflow-requests/run', 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://app.splox.io/api/v1/workflow-requests/run",
  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([
    'workflow_version_id' => '0199e001-a23b-7c8d-1234-567890abcdef',
    'chat_id' => '0199f200-a11b-7c8d-4444-888890abcdef',
    'entry_node_ids' => [
        '0199e002-b34c-8d9e-2345-678901bcdef0'
    ],
    'query' => 'Summarize the latest sales report',
    'files' => [
        
    ]
  ]),
  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://app.splox.io/api/v1/workflow-requests/run"

	payload := strings.NewReader("{\n  \"workflow_version_id\": \"0199e001-a23b-7c8d-1234-567890abcdef\",\n  \"chat_id\": \"0199f200-a11b-7c8d-4444-888890abcdef\",\n  \"entry_node_ids\": [\n    \"0199e002-b34c-8d9e-2345-678901bcdef0\"\n  ],\n  \"query\": \"Summarize the latest sales report\",\n  \"files\": []\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://app.splox.io/api/v1/workflow-requests/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflow_version_id\": \"0199e001-a23b-7c8d-1234-567890abcdef\",\n  \"chat_id\": \"0199f200-a11b-7c8d-4444-888890abcdef\",\n  \"entry_node_ids\": [\n    \"0199e002-b34c-8d9e-2345-678901bcdef0\"\n  ],\n  \"query\": \"Summarize the latest sales report\",\n  \"files\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.splox.io/api/v1/workflow-requests/run")

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  \"workflow_version_id\": \"0199e001-a23b-7c8d-1234-567890abcdef\",\n  \"chat_id\": \"0199f200-a11b-7c8d-4444-888890abcdef\",\n  \"entry_node_ids\": [\n    \"0199e002-b34c-8d9e-2345-678901bcdef0\"\n  ],\n  \"query\": \"Summarize the latest sales report\",\n  \"files\": []\n}"

response = http.request(request)
puts response.read_body

{
  "workflow_request_id": "0199f123-d60e-7ffd-9131-4cc5ab040ee8"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

workflow-requests

run

Run Workflow

curl --request POST \
  --url https://app.splox.io/api/v1/workflow-requests/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflow_version_id": "0199e001-a23b-7c8d-1234-567890abcdef",
  "chat_id": "0199f200-a11b-7c8d-4444-888890abcdef",
  "entry_node_ids": [
    "0199e002-b34c-8d9e-2345-678901bcdef0"
  ],
  "query": "Summarize the latest sales report",
  "files": []
}
'

import requests

url = "https://app.splox.io/api/v1/workflow-requests/run"

payload = {
    "workflow_version_id": "0199e001-a23b-7c8d-1234-567890abcdef",
    "chat_id": "0199f200-a11b-7c8d-4444-888890abcdef",
    "entry_node_ids": ["0199e002-b34c-8d9e-2345-678901bcdef0"],
    "query": "Summarize the latest sales report",
    "files": []
}
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({
    workflow_version_id: '0199e001-a23b-7c8d-1234-567890abcdef',
    chat_id: '0199f200-a11b-7c8d-4444-888890abcdef',
    entry_node_ids: ['0199e002-b34c-8d9e-2345-678901bcdef0'],
    query: 'Summarize the latest sales report',
    files: []
  })
};

fetch('https://app.splox.io/api/v1/workflow-requests/run', 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://app.splox.io/api/v1/workflow-requests/run",
  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([
    'workflow_version_id' => '0199e001-a23b-7c8d-1234-567890abcdef',
    'chat_id' => '0199f200-a11b-7c8d-4444-888890abcdef',
    'entry_node_ids' => [
        '0199e002-b34c-8d9e-2345-678901bcdef0'
    ],
    'query' => 'Summarize the latest sales report',
    'files' => [
        
    ]
  ]),
  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://app.splox.io/api/v1/workflow-requests/run"

	payload := strings.NewReader("{\n  \"workflow_version_id\": \"0199e001-a23b-7c8d-1234-567890abcdef\",\n  \"chat_id\": \"0199f200-a11b-7c8d-4444-888890abcdef\",\n  \"entry_node_ids\": [\n    \"0199e002-b34c-8d9e-2345-678901bcdef0\"\n  ],\n  \"query\": \"Summarize the latest sales report\",\n  \"files\": []\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://app.splox.io/api/v1/workflow-requests/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflow_version_id\": \"0199e001-a23b-7c8d-1234-567890abcdef\",\n  \"chat_id\": \"0199f200-a11b-7c8d-4444-888890abcdef\",\n  \"entry_node_ids\": [\n    \"0199e002-b34c-8d9e-2345-678901bcdef0\"\n  ],\n  \"query\": \"Summarize the latest sales report\",\n  \"files\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.splox.io/api/v1/workflow-requests/run")

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  \"workflow_version_id\": \"0199e001-a23b-7c8d-1234-567890abcdef\",\n  \"chat_id\": \"0199f200-a11b-7c8d-4444-888890abcdef\",\n  \"entry_node_ids\": [\n    \"0199e002-b34c-8d9e-2345-678901bcdef0\"\n  ],\n  \"query\": \"Summarize the latest sales report\",\n  \"files\": []\n}"

response = http.request(request)
puts response.read_body

{
  "workflow_request_id": "0199f123-d60e-7ffd-9131-4cc5ab040ee8"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Triggers a workflow execution. This is the primary way to run workflows programmatically.

Usage

curl -X POST https://app.splox.io/api/v1/workflow-requests/run \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_version_id": "your-workflow-version-id",
    "chat_id": "your-chat-id",
    "entry_node_ids": ["your-entry-node-id"],
    "query": "Your message or instruction",
    "files": []
  }'

from splox import SploxClient

client = SploxClient(api_key="YOUR_API_KEY")
result = client.workflows.run(
    workflow_version_id="your-workflow-version-id",
    chat_id="your-chat-id",
    entry_node_ids=["your-entry-node-id"],
    query="Your message or instruction",
)
print(result.workflow_request_id)

# Or run and wait for completion:
tree = client.workflows.run_and_wait(
    workflow_version_id="your-workflow-version-id",
    chat_id="your-chat-id",
    entry_node_ids=["your-entry-node-id"],
    query="Your message or instruction",
    timeout=300.0,
)
print(tree.execution_tree.status)

import Splox from "splox";

const client = new Splox("YOUR_API_KEY");
const result = await client.workflows.run({
  workflow_version_id: "your-workflow-version-id",
  chat_id: "your-chat-id",
  entry_node_ids: ["your-entry-node-id"],
  query: "Your message or instruction",
});
console.log(result.workflow_request_id);

// Or run and wait for completion:
const tree = await client.workflows.runAndWait({
  workflow_version_id: "your-workflow-version-id",
  chat_id: "your-chat-id",
  entry_node_ids: ["your-entry-node-id"],
  query: "Your message or instruction",
});
console.log(tree.execution_tree.status);

client := splox.NewClient("YOUR_API_KEY")
result, err := client.Workflows.Run(ctx, splox.RunParams{
    WorkflowVersionID: "your-workflow-version-id",
    ChatID:            "your-chat-id",
    EntryNodeIDs:      []string{"your-entry-node-id"},
    Query:             "Your message or instruction",
})
fmt.Println(result.WorkflowRequestID)

// Or run and wait for completion:
tree, err := client.Workflows.RunAndWait(ctx, splox.RunParams{
    WorkflowVersionID: "your-workflow-version-id",
    ChatID:            "your-chat-id",
    EntryNodeIDs:      []string{"your-entry-node-id"},
    Query:             "Your message or instruction",
}, 5*time.Minute)
fmt.Println(tree.ExecutionTree.Status)

How It Works

The API creates a WorkflowRequest with status pending
The request is enqueued for processing
Execution begins at the specified entry node(s)
The entry node receives a payload: { "text": "<query>", "chat_id": "<chat_id>", "files": [...] }
Downstream nodes access this via {{ start.text }}, {{ start.chat_id }}, etc.

Prerequisites

Before running a workflow, you need:

A workflow version ID — Get it via List Workflows or Get Latest Version
Entry node IDs — Get them via Get Entry Nodes
A chat session — Create one via Create Chat

Response

Returns a workflow_request_id you can use to:

Stream results in real-time: Listen to Execution (SSE)
Get the full execution tree: Get Execution Tree
View execution history: Get History

Rate Limit

20 workflow executions per minute per user.

Notes

Authentication required: The authenticated user must own the workflow or have access via a published agent.

Authorizations

Authorization

string

header

required

API token generated from your Splox account settings. Create tokens at https://app.splox.io/account?tab=settings

Body

application/json

workflow_version_id

string<uuid>

required

ID of the workflow version to execute

chat_id

string<uuid>

required

Chat session ID (used for context memory and SSE streaming)

entry_node_ids

string<uuid>[]

required

IDs of the entry nodes to begin execution at

query

string

required

The user message or query text. Available as {{ start.text }} in the workflow.

files

object[]

Optional file attachments. Available as {{ start.files }} in the workflow.

Show child attributes

additional_params

object

Optional extra parameters merged into the payload

Response

Workflow execution started successfully

workflow_request_id

string<uuid>

ID of the created workflow request. Use this to listen for results, get the execution tree, or check status.

Getting Started

Workflows

Workflow Execution

MCP

Chats

Memory

Events

Billing

Run Workflow

Usage

How It Works

Prerequisites

Response

Rate Limit

Notes

Authorizations

Body

Response

​Usage

​How It Works

​Prerequisites

​Response

​Rate Limit

​Notes

Authorizations

Body

Response

Usage

How It Works

Prerequisites

Response

Rate Limit

Notes