Skip to main content
POST
/
v1
/
workflows
/
revisions
/
{revision_id}
/
graph
/
validate
Validate a workflow graph without saving it
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/workflows/revisions/{revision_id}/graph/validate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "compiled_graph": {}
}
'
{
  "valid": true,
  "error_count": 123,
  "warning_count": 123,
  "suggestion_count": 123,
  "findings": [
    {
      "rule_id": "<string>",
      "category": "<string>",
      "message": "<string>",
      "node_id": "<string>",
      "edge_id": "<string>",
      "related_node_ids": [
        "<string>"
      ],
      "related_edge_ids": [
        "<string>"
      ],
      "source_span": {
        "start_line": 123,
        "start_col": 123,
        "end_line": 123,
        "end_col": 123,
        "raw_text_excerpt": "<string>"
      },
      "suggested_fix": "<string>",
      "related_spans": [
        {
          "start_line": 123,
          "start_col": 123,
          "end_line": 123,
          "end_col": 123,
          "raw_text_excerpt": "<string>"
        }
      ]
    }
  ],
  "normalized_graph": {}
}

Authorizations

x-api-key
string
header
required

Path Parameters

revision_id
string<uuid>
required

Body

application/json

Body for validating or manually replacing a revision's compiled graph.

compiled_graph
Compiled Graph · object
required

Response

Successful Response

Validation result for a submitted CompiledWorkflowGraph payload.

valid
boolean
required
error_count
integer
required
warning_count
integer
required
suggestion_count
integer
required
findings
ValidationFinding · object[]
normalized_graph
Normalized Graph · object