Validate Workflow

Validate a workflow definition without executing it

1 min read

post/api/v1/workflow/{workflow_id}/validate

Request example

curl --request POST \
  --url https://voice.menaceui.com/api/v1/workflow/{workflow_id}/validate \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

{
  "is_valid": true,
  "errors": [
    {
      "kind": "node",
      "id": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

post/api/v1/workflow/{workflow_id}/validate

Checks the current workflow definition for structural errors — missing required fields, invalid node configurations, broken edge references — without placing a call or creating a run.

If invalid, the response includes a list of errors each with a kind (node, edge, or workflow), the offending id, the field, and a human-readable message. See Errors for the full error schema.

Path parameters

workflow_idintegerrequired#

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

is_validbooleanrequired#

errorsobject[]required#

Show child attributes

kindenum<string>required#

Options:nodeedgeworkflow

idstring · nullrequired#

Show child attributes

Any of

fieldstring · nullrequired#

Show child attributes

Any of

messagestringrequired#

Archive Agent Create Test Run