Create a workflow

Define the callback endpoint used to execute runs. Callback and failure URLs are validated against the platform SSRF blocklist.

POST/api/v2/workflows

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.

Header parameters

X-Request-Idstring

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

max length 128

Request body

requiredapplication/json

namestringrequired

min length 1 · max length 100

urlstring<uri>required

methodstring

default: "POST"

Allowed:GETPOSTPUTPATCHDELETE

retriesinteger

min 0 · max 10 · default: 3

failureUrlstring<uri>

Responses

201

Public workflow definition returned.

successbooleanrequired

Allowed:true

dataWorkflowrequired

Show properties

workflowIdstringrequired

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

namestringrequired

urlstring<uri>required

methodstringrequired

Allowed:GETPOSTPUTPATCHDELETE

retriesintegerrequired

min 0

failureUrlstring<uri> | nullrequired

isActivebooleanrequired

createdAtstring<date-time>required

updatedAtstring<date-time>

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

402

Payment Required - Usage quota exceeded

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

409

The request conflicts with current resource state or a concurrent decision.

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.

Bodyapplication/json

namestring*urlstring*methodstringretriesintegerfailureUrlstring

Request

curl -X POST 'https://api.anlyon.com/api/v2/workflows' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "url": "http://example.com",
  "method": "GET",
  "retries": 3,
  "failureUrl": "http://example.com"
}'

const response = await fetch("https://api.anlyon.com/api/v2/workflows", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"url\": \"http://example.com\",\n  \"method\": \"GET\",\n  \"retries\": 3,\n  \"failureUrl\": \"http://example.com\"\n}"
});

import requests

response = requests.post(
    "https://api.anlyon.com/api/v2/workflows",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"url\": \"http://example.com\",\n  \"method\": \"GET\",\n  \"retries\": 3,\n  \"failureUrl\": \"http://example.com\"\n}",
)

Response

{
  "success": true,
  "data": {
    "workflowId": "string",
    "name": "string",
    "url": "http://example.com",
    "method": "GET",
    "retries": 0,
    "failureUrl": "http://example.com",
    "isActive": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "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,
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "Daily message quota exceeded. Upgrade your plan to continue."
  }
}

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

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

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