Execute Workflow

Execute a workflow with the provided input data. Workflows can run in streaming or batch mode.

Execution Modes:

• Streaming (stream=true): Real-time step-by-step execution updates via SSE
• Non-Streaming (stream=false): Complete workflow execution with final result

Workflow Execution Process:

1. Input validation against workflow schema
2. Sequential or parallel step execution based on workflow design
3. Data flow between steps with transformation
4. Error handling and automatic retries where configured
5. Final result compilation and response

Session Management: Workflows support session continuity for stateful execution across multiple runs.

POST /workflows/{workflow_id}/runs

Execute Workflow

cURL

curl --request POST \
  --url https://api.example.com/workflows/{workflow_id}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'message=<string>' \
  --data stream=true \
  --data 'session_id=<string>' \
  --data 'user_id=<string>' \
  --data version=123

import requests

url = "https://api.example.com/workflows/{workflow_id}/runs"

payload = {
    "message": "<string>",
    "stream": "true",
    "session_id": "<string>",
    "user_id": "<string>",
    "version": "123"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    message: '<string>',
    stream: 'true',
    session_id: '<string>',
    user_id: '<string>',
    version: '123'
  })
};

fetch('https://api.example.com/workflows/{workflow_id}/runs', 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/workflows/{workflow_id}/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "message=%3Cstring%3E&stream=true&session_id=%3Cstring%3E&user_id=%3Cstring%3E&version=123",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$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/workflows/{workflow_id}/runs"

	payload := strings.NewReader("message=%3Cstring%3E&stream=true&session_id=%3Cstring%3E&user_id=%3Cstring%3E&version=123")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	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/workflows/{workflow_id}/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("message=%3Cstring%3E&stream=true&session_id=%3Cstring%3E&user_id=%3Cstring%3E&version=123")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/workflows/{workflow_id}/runs")

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/x-www-form-urlencoded'
request.body = "message=%3Cstring%3E&stream=true&session_id=%3Cstring%3E&user_id=%3Cstring%3E&version=123"

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

400

{
  "detail": "Bad request",
  "error_code": "BAD_REQUEST"
}

{
  "detail": "Unauthenticated access",
  "error_code": "UNAUTHENTICATED"
}

{
  "detail": "Not found",
  "error_code": "NOT_FOUND"
}

{
  "detail": "Validation error",
  "error_code": "VALIDATION_ERROR"
}

{
  "detail": "Internal server error",
  "error_code": "INTERNAL_SERVER_ERROR"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workflow_id · string · required

Body

application/x-www-form-urlencoded

message · string · required

stream · boolean · default: true

session_id · string | null

user_id · string | null

version · integer | null

Response

200

application/json

Workflow executed successfully