> ## Documentation Index
> Fetch the complete documentation index at: https://docs.b3os.org/llms.txt
> Use this file to discover all available pages before exploring further.

# POST /v1/workflows/validate

Validate a workflow definition without saving

` POST /v1/workflows/validate `

Validate a workflow definition without saving

## Request body (required)

Content type: ` application/json `

Workflow definition and name to validate

- ` value `: type ` unknown `

  - ` oneOf alternative 1 `: type ` object `

  - ` oneOf alternative 2 `: type ` object `

    - Required fields: ` definition `

    - ` definition `: type ` object ` — Definition is the inline workflow graph to analyze. Same shape as a saved workflow's definition. Unlike the ephemeral-run endpoint there is no trigger restriction — analysis is read-only and method-agnostic.

      - Required fields: ` nodes `

      - ` blockExpansions `: type ` object ` — Set on run snapshots only (not workflow DB)

      - ` inputSchema `: type ` array `

        - ` array item `: type ` object `

          - ` description `: type ` string `

          - ` key `: type ` string `

          - ` required `: type ` boolean `

          - ` type `: type ` string ` — "string", "number", "boolean", "object", "array"

      - ` nodes `: type ` object `

      - ` sensitivePropKeys `: type ` array ` — Legacy: kept for old runs; no longer populated for new workflows

        - ` array item `: type ` string `

      - ` triggerNodeIds `: type ` array ` — TriggerNodeIDs lists the node IDs that are trigger (root) nodes. Every workflow declares this — single-trigger workflows ship ["root"] (the legacy node id), multi-trigger workflows list every trigger node id. Treating single-trigger as a forest-of-1 removes the two-path branching throughout the BE + FE; older rows without the field are backfilled by migration 000282 and the field-missing path stays as a read-side safety net (see FindTriggerNodeIDs) but is no longer exercised by saves.  "root" is also a runtime alias for "the trigger that fired this run" — {{root.X}} variable references resolve to the firing trigger regardless of which trigger fired. Don't repurpose the literal "root" as a trigger id on a multi-trigger workflow.

        - ` array item `: type ` string `

      - ` variableDefs `: type ` array ` — VariableDefs is a snapshot of the workflow's declared variables at run creation time. The canonical source lives on the workflows row (Workflow.VariableDefs column). Snapshotted into the run definition so the worker can resolve {{$vars.x}} lookups and route variable-action writes to the right scope without an extra DB round trip.

        - ` array item `: type ` object `

          - ` default `: type ` unknown `

          - ` description `: type ` string `

          - ` lifetime `: type ` string `

            - enum: ` ["persist","reset"] `

          - ` name `: type ` string `

          - ` type `: type ` string `

            - enum: ` ["number","text","boolean","list","object"] `

    - ` name `: type ` string `

## Responses

### ` 200 ` — OK

Content type: ` application/json `

- ` value `: type ` object `

  - ` code `: type ` integer `

    - example: ` 200 `

  - ` data `: type ` object `

    - ` errors `: type ` array `

      - ` array item `: type ` object `

        - ` code `: type ` string ` — Optional stable machine code for consumers to branch on (e.g. pure_variable_type_mismatch)

        - ` field `: type ` string ` — Optional field name

        - ` message `: type ` string ` — Human readable error message

        - ` nodeId `: type ` string ` — Optional node ID

        - ` nodeName `: type ` string ` — Optional node display name

        - ` type `: type ` string ` — name, nodes, root, connectivity, pattern, variable

    - ` valid `: type ` boolean `

  - ` message `: type ` string `

    - example: ` "success" `

  - ` requestId `: type ` string `

    - example: ` "abc-123" `

### ` 400 ` — Bad Request

Content type: ` application/json `

- ` value `: type ` object `

  - ` code `: type ` integer `

  - ` details `: type ` array `

    - ` array item `: type ` unknown `

  - ` message `: type ` string `

  - ` requestId `: type ` string `

## Request examples

### cURL

```curl
curl -X POST 'https://api.example.com/v1/workflows/validate' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'
```

### JavaScript

```javascript
const response = await fetch('https://api.example.com/v1/workflows/validate', {
  method: 'POST',
  headers: {
      "Authorization": "Bearer YOUR_API_TOKEN",
      "Content-Type": "application/json"
  },
  body: JSON.stringify({})
});

const data = await response.json();
console.log(data);
```

### Python

```python
import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.post('https://api.example.com/v1/workflows/validate', headers=headers, json={})
print(response.json())
```

### Go

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{}`)
	req, _ := http.NewRequest("POST", "https://api.example.com/v1/workflows/validate", body)
	req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
	req.Header.Set("Content-Type", "application/json")

	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
	result, _ := io.ReadAll(resp.Body)
	fmt.Println(string(result))
}
```