Skip to content

Validate Query

POST
/api/automations/validate_query
curl --request POST \
--url https://example.com/api/automations/validate_query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "query": "example" }'
Media typeapplication/json
QueryRequest
object
query
required
Query
string
Examplegenerated
{
"query": "example"
}

Successful Response

Media typeapplication/json
QueryResponse
object
success
required
Success
boolean
result
required
Result
integer
message
Any of:
string
error
Any of:
string
Examplegenerated
{
"success": true,
"result": 1,
"message": "example",
"error": "example"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}