Validate a prospective flow payload | Runtype Documentation

curl -X POST https://api.runtype.com/v1/public/flows/validate \
     -H "Content-Type: application/json" \
     -d '{
  "flowSteps": [
    {
      "config": {
        "model": "gpt-5-mini",
        "text": "Use account tool",
        "tools": {
          "toolIds": [
            "tool_missing_flow_validation_docs_example"
          ]
        }
      },
      "name": "Agent Step",
      "type": "prompt"
    }
  ],
  "name": "Flow Validation Auth Context Example"
}'

{
  "context": {
    "accountChecksPerformed": true,
    "accountChecksSkipped": true,
    "authenticated": true
  },
  "errors": [
    {
      "code": "string",
      "message": "string",
      "path": "string",
      "step": {
        "index": 1,
        "name": "string",
        "type": "string"
      }
    }
  ],
  "recommendations": [
    {
      "code": "string",
      "message": "string",
      "path": "string",
      "step": {
        "index": 1,
        "name": "string",
        "type": "string"
      }
    }
  ],
  "valid": true,
  "warnings": [
    {
      "code": "string",
      "message": "string",
      "path": "string",
      "step": {
        "index": 1,
        "name": "string",
        "type": "string"
      }
    }
  ]
}

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

contextobject

errorslist of objects

recommendationslist of objects

validboolean

warningslist of objects

Errors

400

Bad Request Error

500

Internal Server Error

1	{
2	"context": {
3	"accountChecksPerformed": true,
4	"accountChecksSkipped": true,
5	"authenticated": true
6	},
7	"errors": [
8	{
9	"code": "string",
10	"message": "string",
11	"path": "string",
12	"step": {
13	"index": 1,
14	"name": "string",
15	"type": "string"
16	}
17	}
18	],
19	"recommendations": [
20	{
21	"code": "string",
22	"message": "string",
23	"path": "string",
24	"step": {
25	"index": 1,
26	"name": "string",
27	"type": "string"
28	}
29	}
30	],
31	"valid": true,
32	"warnings": [
33	{
34	"code": "string",
35	"message": "string",
36	"path": "string",
37	"step": {
38	"index": 1,
39	"name": "string",
40	"type": "string"
41	}
42	}
43	]
44	}