Overview
Endpoints
- GETList workflow runs
- POSTBulk cancel workflow runs
- POSTBulk replay workflow runs
- GETGet a workflow run
- DELCancel a workflow run
- GETCompare two workflow runs
- POSTCompensate a failed workflow run
- GETGet compensation plan
- GETGet workflow run debug view
- GETExplain workflow run execution
- GETGet workflow run graph
- GETGet workflow run labels
- POSTPause a workflow run
- POSTResume a workflow run
- POSTRetry a workflow run
- GETList workflow step runs
- GETGet workflow run timeline
Workflow Runs
Compensate a failed workflow run
Triggers compensation for previously completed steps in reverse topological order. Only valid for failed or timed_out runs.
POST
/
v1
/
workflow-runs
/
{workflowRunID}
/
compensate
Compensate a failed workflow run
curl --request POST \
--url https://api.strait.dev/v1/workflow-runs/{workflowRunID}/compensate \
--header 'Authorization: Bearer <token>'{
"Steps": [
{
"CompensationJobID": "<string>",
"OriginalOutput": "<unknown>",
"StepRef": "<string>",
"StepRunID": "<string>",
"TimeoutSecs": 123
}
],
"WorkflowRunID": "<string>",
"$schema": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.strait.dev/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API key passed as Bearer token
Path Parameters
⌘I
Compensate a failed workflow run
curl --request POST \
--url https://api.strait.dev/v1/workflow-runs/{workflowRunID}/compensate \
--header 'Authorization: Bearer <token>'{
"Steps": [
{
"CompensationJobID": "<string>",
"OriginalOutput": "<unknown>",
"StepRef": "<string>",
"StepRunID": "<string>",
"TimeoutSecs": 123
}
],
"WorkflowRunID": "<string>",
"$schema": "<string>"
}