Workflow Developer API

Validate Workflow Definition

Preflight canonical workflow JSON against save, audit, and public API rules. This operation does not persist anything. A definition that fails validation still returns HTTP 200 with ``viable=false`` and machine-actionable findings.

View as Markdown View OpenAPI source

POST/developer/v1/workflows/validate

Authorizations

Authorization

stringheaderrequired

Send your GenHealth credential as Bearer <YOUR_API_KEY>. This endpoint requires workflow:read for the authenticated organization.

Headers

Accept

stringheader

Response media type. Use application/json for the current API.

Parameters

This endpoint does not define request parameters.

Request body

Send an application/json request body. This body is required.

WorkflowDefinitionValidationRequest

definitionA genhealth.workflow_definition import envelope. Any JSON value is accepted here so schema mistakes can be returned as structured validation results.WorkflowImportEnvelope | JsonValue

Responses

200Successful Response

WorkflowDefinitionValidationResult

findingsarray<WorkflowAuditFinding>

graph_validboolean

policy_validboolean

readinessstring

runtime_notesarray<WorkflowAuditRuntimeNote>

runtime_verifiedboolean

schema_errorsarray<WorkflowDefinitionSchemaError>

schema_validboolean

422Validation Error

HTTPValidationError

detailarray<ValidationError>

Request example

curl --request POST \
  --url 'https://api.umpa.genhealth.ai/developer/v1/workflows/validate' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "definition": {
    "kind": "genhealth.workflow_definition",
    "schema_version": 1,
    "workflow": {
      "config": {
        "example_key": "…"
      },
      "description": "string",
      "edges": [
        {
          "id": "…",
          "source_node_id": "…",
          "source_output": "…",
          "target_input": "…",
          "target_node_id": "…"
        }
      ],
      "name": "string",
      "nodes": [
        {
          "config": "…",
          "default_value": "…",
          "error_strategy": "…",
          "id": "…",
          "name": "…",
          "position": "…",
          "retry_config": "…",
          "type": "…"
        }
      ],
      "route": "string",
      "trigger": {
        "config": {
          "run_fields": [
            {
              "default": false,
              "key": "dry_run",
              "type": "boolean"
            },
            {
              "key": "limit",
              "required": true,
              "type": "number"
            }
          ]
        },
        "type": "manual"
      }
    }
  }
}'

Response example

{
  "findings": [
    {
      "category": "string",
      "code": "99213",
      "details": {
        "example_key": "string"
      },
      "edge": {
        "example_key": "string"
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "message": "string",
      "node_ids": [
        "string"
      ],
      "severity": "blocking"
    }
  ],
  "graph_valid": true,
  "policy_valid": true,
  "readiness": "blocked",
  "runtime_notes": [
    {
      "category": "string",
      "code": "99213",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "message": "string",
      "node_ids": [
        "string"
      ],
      "suggestion": "string"
    }
  ],
  "runtime_verified": false,
  "schema_errors": [
    {
      "code": "99213",
      "message": "string",
      "path": "string"
    }
  ],
  "schema_valid": true
}

View OpenAPI document