---
title: "Validate a query and return pipeline graph"
---

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

# Validate a query and return pipeline graph

Path: Arroyo REST API › pipelines

`POST /v1/pipelines/validate_query`

URL: `http://localhost:5115/api/v1/pipelines/validate_query`

## Request body

_Required._

- `query` (`validate_query.query`; string, required)
- `udfs` (`validate_query.udfs`; array of object, optional, nullable)
  - `definition` (`validate_query.udfs.definition`; string, required)
  - `language` (`validate_query.udfs.language`; string, optional)
    - one of `"python"`, `"rust"`

## Example request

```json
{
  "query": "string",
  "udfs": [
    {
      "definition": "string",
      "language": "python"
    }
  ]
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url http://localhost:5115/api/v1/pipelines/validate_query \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "string",
  "udfs": [
    {
      "definition": "string",
      "language": "python"
    }
  ]
}
'
```

### TypeScript

```typescript
const url = 'http://localhost:5115/api/v1/pipelines/validate_query';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'string', udfs: [{definition: 'string', language: 'python'}]})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "http://localhost:5115/api/v1/pipelines/validate_query"

payload = {
    "query": "string",
    "udfs": [
        {
            "definition": "string",
            "language": "python"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Validated query

#### Example

```json
{
  "errors": [
    {
      "message": "string",
      "span": {
        "end": {
          "column": 0,
          "line": 0
        },
        "start": {
          "column": 0,
          "line": 0
        }
      }
    }
  ],
  "graph": {
    "edges": [
      {
        "dest_id": 0,
        "edge_type": "string",
        "key_type": "string",
        "src_id": 0,
        "value_type": "string"
      }
    ],
    "nodes": [
      {
        "description": "string",
        "node_id": 0,
        "operator": "string",
        "parallelism": 0
      }
    ]
  }
}
```

- `errors` (`validate_query.response.200.errors`; array of object, required)
  - `message` (`validate_query.response.200.errors.message`; string, required)
  - `span` (`validate_query.response.200.errors.span`; object, optional, nullable)
    - `end` (`validate_query.response.200.errors.span.end`; object, required)
      - `column` (`validate_query.response.200.errors.span.end.column`; integer, required)
        - format: `int64` · minimum: `0`
      - `line` (`validate_query.response.200.errors.span.end.line`; integer, required)
        - format: `int64` · minimum: `0`
    - `start` (`validate_query.response.200.errors.span.start`; object, required)
      - `column` (`validate_query.response.200.errors.span.start.column`; integer, required)
        - format: `int64` · minimum: `0`
      - `line` (`validate_query.response.200.errors.span.start.line`; integer, required)
        - format: `int64` · minimum: `0`
- `graph` (`validate_query.response.200.graph`; object, optional, nullable)
  - `edges` (`validate_query.response.200.graph.edges`; array of object, required)
    - `dest_id` (`validate_query.response.200.graph.edges.dest_id`; integer, required)
      - format: `int32` · minimum: `0`
    - `edge_type` (`validate_query.response.200.graph.edges.edge_type`; string, required)
    - `key_type` (`validate_query.response.200.graph.edges.key_type`; string, required)
    - `src_id` (`validate_query.response.200.graph.edges.src_id`; integer, required)
      - format: `int32` · minimum: `0`
    - `value_type` (`validate_query.response.200.graph.edges.value_type`; string, required)
  - `nodes` (`validate_query.response.200.graph.nodes`; array of object, required)
    - `description` (`validate_query.response.200.graph.nodes.description`; string, required)
    - `node_id` (`validate_query.response.200.graph.nodes.node_id`; integer, required)
      - format: `int32` · minimum: `0`
    - `operator` (`validate_query.response.200.graph.nodes.operator`; string, required)
    - `parallelism` (`validate_query.response.200.graph.nodes.parallelism`; integer, required)
      - format: `int32` · minimum: `0`


Source: https://www.arroyo.dev/docs/api/validate-query/index.md
