DocumentationAPI ReferenceCLI Reference

Workflows

Manage workflow definitions and view run history

View as MarkdownEdit on GitHub

List Workflows Endpoint

GET
/workflows

Query Parameters

workflow_type?|

Filter by workflow type

include_archived?boolean

Include archived workflows

Defaultfalse
page?integer
Default1
Range1 <= value
page_size?integer
Default20
Range1 <= value <= 100
order_by?|

Sort field (- prefix = descending)

Response Body

application/json

application/json

curl -X GET "https://loading/workflows"
{
  "workflows": [
    {
      "id": "string",
      "name": "string",
      "workflow_type": "string",
      "phase_count": 0,
      "created_at": "string",
      "runs_count": 0,
      "is_archived": false
    }
  ],
  "total": 0,
  "page": 1,
  "page_size": 20
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Workflow Endpoint

POST
/workflows

Request Body

application/json

name*string
workflow_type?string
Default"custom"
classification?string
Default"standard"
repository_url?string
Default"https://github.com/example/repo"
repository_ref?string
Default"main"
description?|
phases?array<>|
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/workflows" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "id": "string",
  "name": "string",
  "workflow_type": "string",
  "status": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Workflow Endpoint

GET
/workflows/{workflow_id}

Path Parameters

workflow_id*string

Response Body

application/json

application/json

curl -X GET "https://loading/workflows/string"
{
  "id": "string",
  "name": "string",
  "description": "string",
  "workflow_type": "string",
  "classification": "string",
  "phases": [
    {
      "phase_id": "string",
      "name": "string",
      "order": 0,
      "description": "string",
      "agent_type": "",
      "prompt_template": "string",
      "timeout_seconds": 300,
      "allowed_tools": [
        "string"
      ],
      "argument_hint": "string",
      "model": "string"
    }
  ],
  "input_declarations": [
    {
      "name": "string",
      "description": "string",
      "required": true,
      "default": "string"
    }
  ],
  "created_at": "string",
  "runs_count": 0,
  "runs_link": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Archive (soft-delete) a workflow template

DELETE
/workflows/{workflow_id}

Path Parameters

workflow_id*string

Response Body

application/json

application/json

curl -X DELETE "https://loading/workflows/string"
{
  "workflow_id": "string",
  "status": "string"
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Workflow Runs Endpoint

GET
/workflows/{workflow_id}/runs

Path Parameters

workflow_id*string

Response Body

application/json

application/json

curl -X GET "https://loading/workflows/string/runs"
{
  "runs": [
    {
      "workflow_execution_id": "string",
      "workflow_id": "string",
      "workflow_name": "string",
      "status": "string",
      "started_at": "string",
      "completed_at": "string",
      "completed_phases": 0,
      "total_phases": 0,
      "total_tokens": 0,
      "total_cost_usd": "0",
      "error_message": "string"
    }
  ],
  "total": 0,
  "workflow_id": "string",
  "workflow_name": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Workflow History Endpoint

GET
/workflows/{workflow_id}/history

Path Parameters

workflow_id*string

Response Body

application/json

application/json

curl -X GET "https://loading/workflows/string/history"
{
  "workflow_id": "string",
  "workflow_name": "string",
  "executions": [
    {}
  ],
  "total_executions": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Validate Yaml Endpoint

POST
/workflows/validate

Request Body

application/json

file*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/workflows/validate" \  -H "Content-Type: application/json" \  -d '{    "file": "string"  }'
{
  "valid": true,
  "name": "",
  "workflow_type": "",
  "phase_count": 0,
  "errors": [
    "string"
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Phase Prompt Endpoint

PUT
/workflows/{workflow_id}/phases/{phase_id}

Path Parameters

workflow_id*string
phase_id*string

Request Body

application/json

prompt_template*string
Length1 <= length
model?|
timeout_seconds?|
allowed_tools?array<>|
[key: string]?never

Response Body

application/json

application/json

curl -X PUT "https://loading/workflows/string/phases/string" \  -H "Content-Type: application/json" \  -d '{    "prompt_template": "string"  }'
{
  "workflow_id": "string",
  "phase_id": "string",
  "status": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Syntropic137 Docs v0.18.0 · Last updated March 2026

API Reference

REST API documentation for the Syntropic137 Dashboard API, auto-generated from the OpenAPI specification.

Execution

Execute workflows and monitor active executions

On this page

List Workflows EndpointCreate Workflow EndpointGet Workflow EndpointArchive (soft-delete) a workflow templateList Workflow Runs EndpointGet Workflow History EndpointValidate Yaml EndpointUpdate Phase Prompt Endpoint