Validate a prospective flow payload | Runtype Documentation

curl -X POST https://api.runtype.com/v1/public/flows/validate \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "valid": true,
  "errors": [
    {
      "code": "FLOW_MISSING_TRIGGER",
      "message": "The flow must have at least one trigger defined.",
      "path": "/triggers",
      "step": {
        "index": 0,
        "name": "Start",
        "type": "trigger"
      },
      "details": null
    }
  ],
  "warnings": [
    {
      "code": "DEPRECATED_STEP_TYPE",
      "message": "The step type 'legacyAction' is deprecated and will be removed in future versions.",
      "path": "/steps/2",
      "step": {
        "index": 2,
        "name": "Legacy Action",
        "type": "legacyAction"
      },
      "details": null
    }
  ],
  "recommendations": [
    {
      "code": "ADD_ERROR_HANDLING",
      "message": "Consider adding error handling steps to improve flow reliability.",
      "path": "/steps",
      "step": {
        "index": 3,
        "name": "Error Handler",
        "type": "errorHandler"
      },
      "details": null
    }
  ],
  "context": {
    "authenticated": true,
    "accountChecksPerformed": true,
    "accountChecksSkipped": false
  }
}

Validates a flow definition without creating it. Authentication is optional — authenticated requests get additional account-scoped checks.

Request

This endpoint expects a map from strings to any.

Response

Validation result

validboolean

errorslist of objects

warningslist of objects

recommendationslist of objects

contextobject

Errors

400

Bad Request Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/public/flows/validate \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"valid": true,
3	"errors": [
4	{
5	"code": "FLOW_MISSING_TRIGGER",
6	"message": "The flow must have at least one trigger defined.",
7	"path": "/triggers",
8	"step": {
9	"index": 0,
10	"name": "Start",
11	"type": "trigger"
12	},
13	"details": null
14	}
15	],
16	"warnings": [
17	{
18	"code": "DEPRECATED_STEP_TYPE",
19	"message": "The step type 'legacyAction' is deprecated and will be removed in future versions.",
20	"path": "/steps/2",
21	"step": {
22	"index": 2,
23	"name": "Legacy Action",
24	"type": "legacyAction"
25	},
26	"details": null
27	}
28	],
29	"recommendations": [
30	{
31	"code": "ADD_ERROR_HANDLING",
32	"message": "Consider adding error handling steps to improve flow reliability.",
33	"path": "/steps",
34	"step": {
35	"index": 3,
36	"name": "Error Handler",
37	"type": "errorHandler"
38	},
39	"details": null
40	}
41	],
42	"context": {
43	"authenticated": true,
44	"accountChecksPerformed": true,
45	"accountChecksSkipped": false
46	}
47	}