Validate workflow

curl --request POST \
  --url https://openapi.enginy.ai/v1/workflows/validate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "plan": {
    "nodes": [
      {
        "id": "<string>",
        "kind": "BLOCK",
        "blockId": "<string>",
        "inputs": {},
        "next": [
          "<string>"
        ]
      }
    ],
    "name": "<string>"
  },
  "trigger": {
    "type": "MANUAL"
  },
  "maxCreditsPerRun": 123
}
'

import requests

url = "https://openapi.enginy.ai/v1/workflows/validate"

payload = {
    "name": "<string>",
    "plan": {
        "nodes": [
            {
                "id": "<string>",
                "kind": "BLOCK",
                "blockId": "<string>",
                "inputs": {},
                "next": ["<string>"]
            }
        ],
        "name": "<string>"
    },
    "trigger": { "type": "MANUAL" },
    "maxCreditsPerRun": 123
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    plan: {
      nodes: [
        {
          id: '<string>',
          kind: 'BLOCK',
          blockId: '<string>',
          inputs: {},
          next: ['<string>']
        }
      ],
      name: '<string>'
    },
    trigger: {type: 'MANUAL'},
    maxCreditsPerRun: 123
  })
};

fetch('https://openapi.enginy.ai/v1/workflows/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openapi.enginy.ai/v1/workflows/validate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'plan' => [
        'nodes' => [
                [
                                'id' => '<string>',
                                'kind' => 'BLOCK',
                                'blockId' => '<string>',
                                'inputs' => [
                                                                
                                ],
                                'next' => [
                                                                '<string>'
                                ]
                ]
        ],
        'name' => '<string>'
    ],
    'trigger' => [
        'type' => 'MANUAL'
    ],
    'maxCreditsPerRun' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openapi.enginy.ai/v1/workflows/validate"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"plan\": {\n    \"nodes\": [\n      {\n        \"id\": \"<string>\",\n        \"kind\": \"BLOCK\",\n        \"blockId\": \"<string>\",\n        \"inputs\": {},\n        \"next\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"name\": \"<string>\"\n  },\n  \"trigger\": {\n    \"type\": \"MANUAL\"\n  },\n  \"maxCreditsPerRun\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://openapi.enginy.ai/v1/workflows/validate")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"plan\": {\n    \"nodes\": [\n      {\n        \"id\": \"<string>\",\n        \"kind\": \"BLOCK\",\n        \"blockId\": \"<string>\",\n        \"inputs\": {},\n        \"next\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"name\": \"<string>\"\n  },\n  \"trigger\": {\n    \"type\": \"MANUAL\"\n  },\n  \"maxCreditsPerRun\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://openapi.enginy.ai/v1/workflows/validate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"plan\": {\n    \"nodes\": [\n      {\n        \"id\": \"<string>\",\n        \"kind\": \"BLOCK\",\n        \"blockId\": \"<string>\",\n        \"inputs\": {},\n        \"next\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"name\": \"<string>\"\n  },\n  \"trigger\": {\n    \"type\": \"MANUAL\"\n  },\n  \"maxCreditsPerRun\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "<string>",
  "data": {
    "isValid": true,
    "warnings": [
      "<string>"
    ],
    "errors": [
      "<string>"
    ]
  }
}

Workflows

Validate workflow

Validate a workflow plan payload without creating anything. Strict validation (as if publishing). Returns isValid with warnings, or errors.

A workflow is a DAG of nodes described by the plan object: { name?, nodes: [] }. Each node has a stable string id and a next array of node ids it points to (an empty string "" marks an unwired slot). There are three node kinds:

BLOCK — one workflow step. { id, kind: "BLOCK", blockId, inputs: {}, next: [] }. blockId comes from GET /v1/workflows/blocks; inputs are the block’s configurable inputs (discover them with GET /v1/workflows/blocks/{blockId}). A BLOCK has exactly one next slot, except the WAIT_FOR_APPROVAL block which has two: [approvedTargetId, rejectedTargetId].
CONDITIONAL — branches the stream. { id, kind: "CONDITIONAL", conditions: [], fallbackName?, next: [] }. Each condition is EITHER a field predicate { field, operator, value? } (lead/company/AI-variable fields — discover them with GET /v1/workflows/condition-fields) OR a random-split branch { type: "RANDOM_SPLIT", percentage } (deterministic A/B split; integer 1-100, percentages must sum to ≤ 100 across the node, the remainder falls through to the fallback). next has exactly conditions.length + 1 entries: one target per matched condition (in order) then the fallback target LAST.
KING — dedupes/groups the stream. { id, kind: "KING", groupBy, orderBy, checkAnyDomain?, limit?, next: [] }. next is [leftTargetId, rightTargetId].

The first node (the one no other node points to) should be a selector/import entry block. A plan may hold at most 60 nodes and no cycles. An empty plan (nodes: []) is valid for a brand-new draft. Field/entity prefixes used inside conditions: company., anyLead., and webhookInput. for webhook-triggered workflows.

Required scope: WORKFLOWS_WRITE

Rate limit: 30 requests per minute

POST

workflows

validate

Validate workflow

curl --request POST \
  --url https://openapi.enginy.ai/v1/workflows/validate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "plan": {
    "nodes": [
      {
        "id": "<string>",
        "kind": "BLOCK",
        "blockId": "<string>",
        "inputs": {},
        "next": [
          "<string>"
        ]
      }
    ],
    "name": "<string>"
  },
  "trigger": {
    "type": "MANUAL"
  },
  "maxCreditsPerRun": 123
}
'

import requests

url = "https://openapi.enginy.ai/v1/workflows/validate"

payload = {
    "name": "<string>",
    "plan": {
        "nodes": [
            {
                "id": "<string>",
                "kind": "BLOCK",
                "blockId": "<string>",
                "inputs": {},
                "next": ["<string>"]
            }
        ],
        "name": "<string>"
    },
    "trigger": { "type": "MANUAL" },
    "maxCreditsPerRun": 123
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    plan: {
      nodes: [
        {
          id: '<string>',
          kind: 'BLOCK',
          blockId: '<string>',
          inputs: {},
          next: ['<string>']
        }
      ],
      name: '<string>'
    },
    trigger: {type: 'MANUAL'},
    maxCreditsPerRun: 123
  })
};

fetch('https://openapi.enginy.ai/v1/workflows/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openapi.enginy.ai/v1/workflows/validate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'plan' => [
        'nodes' => [
                [
                                'id' => '<string>',
                                'kind' => 'BLOCK',
                                'blockId' => '<string>',
                                'inputs' => [
                                                                
                                ],
                                'next' => [
                                                                '<string>'
                                ]
                ]
        ],
        'name' => '<string>'
    ],
    'trigger' => [
        'type' => 'MANUAL'
    ],
    'maxCreditsPerRun' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openapi.enginy.ai/v1/workflows/validate"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"plan\": {\n    \"nodes\": [\n      {\n        \"id\": \"<string>\",\n        \"kind\": \"BLOCK\",\n        \"blockId\": \"<string>\",\n        \"inputs\": {},\n        \"next\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"name\": \"<string>\"\n  },\n  \"trigger\": {\n    \"type\": \"MANUAL\"\n  },\n  \"maxCreditsPerRun\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://openapi.enginy.ai/v1/workflows/validate")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"plan\": {\n    \"nodes\": [\n      {\n        \"id\": \"<string>\",\n        \"kind\": \"BLOCK\",\n        \"blockId\": \"<string>\",\n        \"inputs\": {},\n        \"next\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"name\": \"<string>\"\n  },\n  \"trigger\": {\n    \"type\": \"MANUAL\"\n  },\n  \"maxCreditsPerRun\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://openapi.enginy.ai/v1/workflows/validate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"plan\": {\n    \"nodes\": [\n      {\n        \"id\": \"<string>\",\n        \"kind\": \"BLOCK\",\n        \"blockId\": \"<string>\",\n        \"inputs\": {},\n        \"next\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"name\": \"<string>\"\n  },\n  \"trigger\": {\n    \"type\": \"MANUAL\"\n  },\n  \"maxCreditsPerRun\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "<string>",
  "data": {
    "isValid": true,
    "warnings": [
      "<string>"
    ],
    "errors": [
      "<string>"
    ]
  }
}

Authorizations

x-api-key

string

header

required

Body

application/json

name

string

required

Workflow name.

Required string length: 1 - 120

plan

WorkflowPlan · object

required

The workflow DAG. See the endpoint description for the plan format.

Show child attributes

trigger

WorkflowTrigger · object

Trigger config. Defaults to MANUAL.

WorkflowTrigger
WorkflowTrigger
WorkflowTrigger
WorkflowTrigger
WorkflowTrigger

Show child attributes

maxCreditsPerRun

integer | null

Optional per-run credit ceiling.

Response

Plan is valid

status

enum<string>

required

Available options:

success

message

string

required

data

object

required

Show child attributes

Update workflow folder Get a single workflow

API documentation

Endpoints

Validate workflow

Authorizations

Body

Response