Workflow management

Comprehensive workflow lifecycle management including HTTP-triggered execution, status monitoring, and workflow termination.

Authentication

None

No authentication required for workflow management endpoints. Database credentials are provided in request body when needed.

Endpoints

Get Workflow Status

GET

/workflows/v1/status/{workflow_id}/{run_id}

Retrieve real-time execution status, progress metrics, and result data for a specific workflow run instance, including start/end timestamps and error details if the workflow failed.

Path Parameters

workflow_idstringREQUIRED

Unique identifier for the workflow definition

Example:"4b805f36-48c5-4dd3-942f-650e06f75bbc"

run_idstringREQUIRED

Unique identifier for a specific execution instance of the workflow

Example:"efe16ffe-24b2-4391-a7ec-7000c32c5893"

Response

200Workflow status retrieved successfully

successbooleanREQUIRED

Boolean flag indicating whether the status request was processed successfully, regardless of workflow execution state

Example:

true

messagestringREQUIRED

Human-readable confirmation message indicating successful status retrieval operation

Example:"Workflow status fetched successfully"

dataobjectREQUIRED

Workflow execution state and metadata returned by the underlying workflow client implementation

Error Codes

400

Bad Request

Invalid workflow ID or run ID format

401

Unauthorized

Missing or invalid authentication token

404

Not Found

Workflow or workflow run not found

500

Internal Server Error

Workflow operation failed

Code examples - Get Workflow Status

cURL

BASH Request (cURL)

curl -X GET "http://localhost:8000/workflows/v1/status/4b805f36-48c5-4dd3-942f-650e06f75bbc/efe16ffe-24b2-4391-a7ec-7000c32c5893"

Python

Python Request (Python)

import requests

response = requests.get(
  f"http://localhost:8000/workflows/v1/status/{workflow_id}/{run_id}"
)
status_data = response.json()