For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • POSTValidate a prospective flow payload
Dashboard
LogoLogo
Runtype APIFlow Validation

Validate a prospective flow payload

POST
/v1/public/flows/validate
POST
/v1/public/flows/validate
$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"
>}'
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}

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

Was this page helpful?
Previous

Validate a full product object (FPO)

Next
Built with

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