Skip to content
Arroyo Documentation
Docs
API reference
Search
documentation
Ctrl K
Docs
API reference
Navigation
Arroyo REST API
/
pipelines
Validate a query and return pipeline graph
POST
/v1/pipelines/validate_query
http://localhost:5115/api/v1/pipelines/validate_query
Copy page
|
Markdown
View as Markdown
Request body
JSON
required
Expand all
Collapse all
query
string
required
udfs
optional
array of
object
or null
{
2 properties
}
definition
string
required
language
optional
python
or
rust
}
Returns
200
Validated query
JSON
Expand all
Collapse all
errors
array of
object
required
{
2 properties
}
message
string
required
span
optional
object
or null
{
2 properties
}
end
object
required
{
2 properties
}
column
integer
required
format:
int64
· minimum:
0
line
integer
required
format:
int64
· minimum:
0
}
start
object
required
{
2 properties
}
column
integer
required
format:
int64
· minimum:
0
line
integer
required
format:
int64
· minimum:
0
}
}
}
graph
optional
object
or null
{
2 properties
}
edges
array of
object
required
{
5 properties
}
dest_id
integer
required
format:
int32
· minimum:
0
edge_type
string
required
key_type
string
required
src_id
integer
required
format:
int32
· minimum:
0
value_type
string
required
}
nodes
array of
object
required
{
4 properties
}
description
string
required
node_id
integer
required
format:
int32
· minimum:
0
operator
string
required
parallelism
integer
required
format:
int32
· minimum:
0
}
}
[
Previous
Create a new preview pipeline
Next
Get a single pipeline
]
Esc
Type to search…
↑↓ navigate
↵ select
Esc close
Single-key shortcuts
/ [ ]