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"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
description
string

Response

200 - application/json

Success

​
query
Query · object

Query is a structured query that can be used to find entities in the system. It consists of multiple parts, each representing a different filter or sub-query. The parts are combined using the operand to form the final result:

  • AND (default): returns only entities matching ALL parts (intersection).
  • OR: returns entities matching ANY part (union).
  • EXCEPT: requires exactly 2 parts — returns entities from part[0] that are NOT in part[1].
  • UPSTREAM: returns entities that are upstream (dependencies) of the entities matched by the parts.
  • DOWNSTREAM: returns entities that are downstream (dependents) of the entities matched by the parts.

Queries can be nested by using a Query as a QueryPart, enabling complex compositions like "upstream of all Snowflake tables". query.except_requires_two_parts // QUERY_OPERAND_EXCEPT requires exactly 2 parts