Start a new workflow run

curl --request POST \
  --url {protocol}://{host}:{port}/workflow/run/{type} \
  --header 'X-Auth: <api-key>'

const options = {method: 'POST', headers: {'X-Auth': '<api-key>'}};

fetch('{protocol}://{host}:{port}/workflow/run/{type}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "62437",
  CURLOPT_URL => "{protocol}://{host}:{port}/workflow/run/{type}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-Auth: <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"
	"net/http"
	"io"
)

func main() {

	url := "{protocol}://{host}:{port}/workflow/run/{type}"

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

	req.Header.Add("X-Auth", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("{protocol}://{host}:{port}/workflow/run/{type}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["X-Auth"] = '<api-key>'

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

{
  "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "type": "sage",
  "state": "running",
  "percent": 0,
  "current_step": "step-001",
  "started_at": "2026-02-19T12:00:00+00:00",
  "ended_at": null,
  "duration_ms": null,
  "result": null,
  "errors": null,
  "number_of_steps": 5,
  "meta": {
    "steps": [
      {
        "id": "step-001",
        "run_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
        "name": "creating_sage",
        "step_order": 0,
        "state": "running",
        "timing_avg_ms": 5000,
        "timing_min_ms": 3000,
        "timing_max_ms": 8000,
        "label": [
          "Creating",
          "Sage"
        ],
        "started_at": "2026-02-19T12:00:00+00:00",
        "ended_at": null,
        "duration_ms": null,
        "number_of_steps": 5
      }
    ],
    "current_step": {
      "id": "step-001",
      "name": "creating_sage",
      "state": "running",
      "step_order": 0
    },
    "first_step": {
      "id": "step-001",
      "name": "creating_sage",
      "step_order": 0
    },
    "last_step": {
      "id": "step-005",
      "name": "enlightenment",
      "step_order": 4
    },
    "next_step": {
      "id": "step-002",
      "name": "reading_context",
      "step_order": 1
    }
  }
}

POST

workflow

run

{type}

Start a new workflow run

curl --request POST \
  --url {protocol}://{host}:{port}/workflow/run/{type} \
  --header 'X-Auth: <api-key>'

const options = {method: 'POST', headers: {'X-Auth': '<api-key>'}};

fetch('{protocol}://{host}:{port}/workflow/run/{type}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "62437",
  CURLOPT_URL => "{protocol}://{host}:{port}/workflow/run/{type}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-Auth: <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"
	"net/http"
	"io"
)

func main() {

	url := "{protocol}://{host}:{port}/workflow/run/{type}"

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

	req.Header.Add("X-Auth", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("{protocol}://{host}:{port}/workflow/run/{type}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["X-Auth"] = '<api-key>'

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

{
  "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "type": "sage",
  "state": "running",
  "percent": 0,
  "current_step": "step-001",
  "started_at": "2026-02-19T12:00:00+00:00",
  "ended_at": null,
  "duration_ms": null,
  "result": null,
  "errors": null,
  "number_of_steps": 5,
  "meta": {
    "steps": [
      {
        "id": "step-001",
        "run_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
        "name": "creating_sage",
        "step_order": 0,
        "state": "running",
        "timing_avg_ms": 5000,
        "timing_min_ms": 3000,
        "timing_max_ms": 8000,
        "label": [
          "Creating",
          "Sage"
        ],
        "started_at": "2026-02-19T12:00:00+00:00",
        "ended_at": null,
        "duration_ms": null,
        "number_of_steps": 5
      }
    ],
    "current_step": {
      "id": "step-001",
      "name": "creating_sage",
      "state": "running",
      "step_order": 0
    },
    "first_step": {
      "id": "step-001",
      "name": "creating_sage",
      "step_order": 0
    },
    "last_step": {
      "id": "step-005",
      "name": "enlightenment",
      "step_order": 4
    },
    "next_step": {
      "id": "step-002",
      "name": "reading_context",
      "step_order": 1
    }
  }
}

Authorizations

X-Auth

string

header

required

Service-to-service API key

Headers

X-Permission-Info

string

Required API key permission: valid (informational only -- enforced server-side)

Path Parameters

type

string

required

Workflow type (matches template step definitions, e.g., sage, sage-nc)

Response

Run started successfully

Workflow run record (from WorkflowRunModel.to_dict())

string<uuid>

Run UUID

type

string

Workflow type (e.g., sage, sage-nc)

state

enum<string>

Current state of the workflow run:

queued -- created but not yet started
running -- actively executing steps
finished -- all steps completed successfully
failed -- a step failed or out-of-order transition
canceled -- manually cancelled

Available options:

queued,

running,

finished,

failed,

canceled

percent

integer

Progress percentage

Required range: 0 <= x <= 100

current_step

string | null

ID of the currently running step (null when ended)

started_at

string<date-time>

When the run was created

ended_at

string<date-time> | null

When the run ended (null if still running)

duration_ms

integer | null

Total run duration in milliseconds

number_of_steps

integer

Total number of steps in this run

result

object | null

Run result data

errors

object | null

Error details (e.g., {"message": "Run canceled"})

Public API

Internal API

Start a new workflow run

Authorizations

Headers

Path Parameters

Response