curl --request POST \
--url https://api.modulex.dev/workflows/run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Organization-ID: <api-key>' \
--data '
{
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input": {}
}
'import requests
url = "https://api.modulex.dev/workflows/run"
payload = {
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input": {}
}
headers = {
"Authorization": "Bearer <token>",
"X-Organization-ID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Organization-ID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', input: {}})
};
fetch('https://api.modulex.dev/workflows/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://api.modulex.dev/workflows/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_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'input' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Organization-ID: <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://api.modulex.dev/workflows/run"
payload := strings.NewReader("{\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Organization-ID", "<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://api.modulex.dev/workflows/run")
.header("Authorization", "Bearer <token>")
.header("X-Organization-ID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.modulex.dev/workflows/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Organization-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "running",
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"thread_id": "<string>",
"chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ephemeral": true,
"stream": true,
"workflow_name": "<string>",
"workflow_version": "<string>",
"workflow_source": "database",
"elapsed_ms": 123,
"human_message": {},
"ai_message": {},
"message": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"code": "credit_plan_exhausted",
"layer": "credit",
"key": null,
"current": 1000,
"limit": 1000,
"reason": "credit_plan_exhausted"
}{
"code": "quota_exceeded",
"layer": "quota",
"key": "max_knowledge_bases",
"current": 10,
"limit": 10,
"reason": "quota_exceeded"
}{
"detail": "<string>"
}{
"code": "rate_limit_exceeded",
"layer": "rate",
"key": "sync_exec",
"current": null,
"limit": 60,
"reason": "rate_limit_exceeded"
}Run a workflow
Execute a workflow. Returns immediately with a run_id/thread_id; the workflow runs in the background (track progress via the run/listen surfaces). Subject to the synchronous billing admission gate (reject-before-write): an exhausted credit allowance, exceeded quota, or rate limit returns a flat DenialEnvelope with status 402/403/429 and no run is created. The workflow must have an active deployment.
curl --request POST \
--url https://api.modulex.dev/workflows/run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Organization-ID: <api-key>' \
--data '
{
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input": {}
}
'import requests
url = "https://api.modulex.dev/workflows/run"
payload = {
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input": {}
}
headers = {
"Authorization": "Bearer <token>",
"X-Organization-ID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Organization-ID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', input: {}})
};
fetch('https://api.modulex.dev/workflows/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://api.modulex.dev/workflows/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_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'input' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Organization-ID: <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://api.modulex.dev/workflows/run"
payload := strings.NewReader("{\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Organization-ID", "<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://api.modulex.dev/workflows/run")
.header("Authorization", "Bearer <token>")
.header("X-Organization-ID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.modulex.dev/workflows/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Organization-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"input\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "running",
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"thread_id": "<string>",
"chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ephemeral": true,
"stream": true,
"workflow_name": "<string>",
"workflow_version": "<string>",
"workflow_source": "database",
"elapsed_ms": 123,
"human_message": {},
"ai_message": {},
"message": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"code": "credit_plan_exhausted",
"layer": "credit",
"key": null,
"current": 1000,
"limit": 1000,
"reason": "credit_plan_exhausted"
}{
"code": "quota_exceeded",
"layer": "quota",
"key": "max_knowledge_bases",
"current": 10,
"limit": 10,
"reason": "quota_exceeded"
}{
"detail": "<string>"
}{
"code": "rate_limit_exceeded",
"layer": "rate",
"key": "sync_exec",
"current": null,
"limit": 60,
"reason": "rate_limit_exceeded"
}Authorizations
User API key: Authorization: Bearer mx_live_*. The X-API-KEY: mx_live_* header is also accepted.
Required organization context for org-scoped endpoints.
Body
Response
Run accepted and started in the background.
Acknowledgement that the run started in the background.
"running"
Null when ephemeral=true.
One of: database, request, system:.
"database"
Was this page helpful?