Skip to main content
POST
/
api
/
queries
/
v1
/
generate
GenerateQuery
curl --request POST \
  --url https://developer.synq.io/api/queries/v1/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>"
}
'
{
  "query": {
    "parts": [
      {
        "identifierList": {
          "identifiers": [
            {
              "airflowDag": {
                "integrationId": "<string>",
                "dagId": "<string>"
              }
            }
          ]
        }
      }
    ],
    "operand": "QUERY_OPERAND_UNSPECIFIED"
  },
  "resolverQl": "<string>",
  "unsupportedReason": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.synq.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
description
string
Minimum string length: 1

Response

200 - application/json

Success

​
query
Query · object

The public Query proto. Absent when unsupported.

​
resolverQl
string | null

The generated ResolverQL query string. Empty when unsupported.

​
unsupportedReason
string | null

When the LLM determines the request cannot be expressed as a query, this field contains the reason(s). The other fields will be empty.