Start a specific step

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "<string>",
  "percent": 50,
  "current_step": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "duration_ms": 123,
  "number_of_steps": 123,
  "result": {},
  "errors": {},
  "meta": {
    "steps": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "step_order": 123,
        "timing_avg_ms": 123,
        "timing_min_ms": 123,
        "timing_max_ms": 123,
        "label": [
          "<string>"
        ],
        "started_at": "2023-11-07T05:31:56Z",
        "ended_at": "2023-11-07T05:31:56Z",
        "duration_ms": 123,
        "number_of_steps": 123,
        "current_duration": 123
      }
    ],
    "current_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "step_order": 123,
      "timing_avg_ms": 123,
      "timing_min_ms": 123,
      "timing_max_ms": 123,
      "label": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "number_of_steps": 123,
      "current_duration": 123
    },
    "next_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "step_order": 123,
      "timing_avg_ms": 123,
      "timing_min_ms": 123,
      "timing_max_ms": 123,
      "label": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "number_of_steps": 123,
      "current_duration": 123
    },
    "previous_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "step_order": 123,
      "timing_avg_ms": 123,
      "timing_min_ms": 123,
      "timing_max_ms": 123,
      "label": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "number_of_steps": 123,
      "current_duration": 123
    },
    "first_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "step_order": 123,
      "timing_avg_ms": 123,
      "timing_min_ms": 123,
      "timing_max_ms": 123,
      "label": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "number_of_steps": 123,
      "current_duration": 123
    },
    "last_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "step_order": 123,
      "timing_avg_ms": 123,
      "timing_min_ms": 123,
      "timing_max_ms": 123,
      "label": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "number_of_steps": 123,
      "current_duration": 123
    }
  }
}

GET

workflow

run

{run_id}

start_step

{step_name}

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "<string>",
  "percent": 50,
  "current_step": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "duration_ms": 123,
  "number_of_steps": 123,
  "result": {},
  "errors": {},
  "meta": {
    "steps": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "step_order": 123,
        "timing_avg_ms": 123,
        "timing_min_ms": 123,
        "timing_max_ms": 123,
        "label": [
          "<string>"
        ],
        "started_at": "2023-11-07T05:31:56Z",
        "ended_at": "2023-11-07T05:31:56Z",
        "duration_ms": 123,
        "number_of_steps": 123,
        "current_duration": 123
      }
    ],
    "current_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "step_order": 123,
      "timing_avg_ms": 123,
      "timing_min_ms": 123,
      "timing_max_ms": 123,
      "label": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "number_of_steps": 123,
      "current_duration": 123
    },
    "next_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "step_order": 123,
      "timing_avg_ms": 123,
      "timing_min_ms": 123,
      "timing_max_ms": 123,
      "label": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "number_of_steps": 123,
      "current_duration": 123
    },
    "previous_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "step_order": 123,
      "timing_avg_ms": 123,
      "timing_min_ms": 123,
      "timing_max_ms": 123,
      "label": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "number_of_steps": 123,
      "current_duration": 123
    },
    "first_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "step_order": 123,
      "timing_avg_ms": 123,
      "timing_min_ms": 123,
      "timing_max_ms": 123,
      "label": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "number_of_steps": 123,
      "current_duration": 123
    },
    "last_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "step_order": 123,
      "timing_avg_ms": 123,
      "timing_min_ms": 123,
      "timing_max_ms": 123,
      "label": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "number_of_steps": 123,
      "current_duration": 123
    }
  }
}

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

run_id

string<uuid>

required

UUID of the workflow run

step_name

string

required

Name of the step to start

Response

Step started

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

Authorizations

Headers

Path Parameters

Response