Trigger a workflow run

Accepts an optional JSON payload up to 1 MB. Inactive workflows return WORKFLOW_INACTIVE.

POST/api/v2/workflows/{workflowId}/trigger

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Path parameters

workflowIdstringrequired

Public workflow identifier.

matches ^wfl_[A-Za-z0-9_-]{21}$

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Request body

requiredapplication/json

payloadany

Any JSON value whose serialized form is at most 1 MB.

runIdstring

Existing run in this API key environment for workflow spans.

max length 80

parentSpanIdstring

max length 80

Responses

202

Workflow run accepted for asynchronous execution.

successbooleanrequired

Allowed:true

dataobjectrequired

Show properties

runIdstringrequired

matches ^wfr_[A-Za-z0-9_-]{21}$

workflowIdstringrequired

matches ^wfl_[A-Za-z0-9_-]{21}$

statusstringrequired

Allowed:pending

createdAtstring<date-time>required

400

Bad Request - Invalid input data

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

404

Not Found - Resource does not exist

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

429

Too Many Requests - Rate limit exceeded

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.workflowIdpath*Public workflow identifier.

Bodyapplication/json

payloadstringAny JSON value whose serialized form is at most 1 MB.runIdstringExisting run in this API key environment for workflow spans.parentSpanIdstring

Request

curl -X POST 'https://api.anlyon.com/api/v2/workflows/string/trigger' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "payload": null,
  "runId": "string",
  "parentSpanId": "string"
}'

const response = await fetch("https://api.anlyon.com/api/v2/workflows/string/trigger", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"payload\": null,\n  \"runId\": \"string\",\n  \"parentSpanId\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.anlyon.com/api/v2/workflows/string/trigger",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"payload\": null,\n  \"runId\": \"string\",\n  \"parentSpanId\": \"string\"\n}",
)

Response

{
  "success": true,
  "data": {
    "runId": "string",
    "workflowId": "string",
    "status": "pending",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {
      "url": "Invalid URL format"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later."
  }
}