Skip to main content
POST
/
sources
/
{sourceKey}
/
v1
/
queries
Run multiple queries
curl --request POST \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/queries \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '
{
  "requests": [
    {
      "collectionKeys": [
        "<string>"
      ],
      "params": {
        "semanticQuery": {
          "value": "<string>",
          "paths": {
            "include": [
              "<string>"
            ],
            "exclude": [
              "<string>"
            ]
          }
        },
        "query": {
          "and": "<array>",
          "id": "<string>"
        },
        "filter": {
          "and": "<array>",
          "id": "<string>"
        },
        "properties": {
          "include": [
            "<string>"
          ],
          "exclude": [
            "<string>"
          ]
        },
        "highlighting": [
          "<string>"
        ],
        "page": 123,
        "perPage": 20,
        "sort": {
          "path": "<string>",
          "direction": "DESC"
        },
        "ranking": {
          "type": "DEFAULT"
        },
        "aggregations": [
          {
            "type": "LEXICAL",
            "path": "<string>",
            "prefix": "<string>",
            "size": 20
          }
        ],
        "traversedProperties": [
          "<string>"
        ]
      }
    }
  ]
}
'
{
  "responses": [
    {
      "collectionKeys": [
        "<string>"
      ],
      "response": {
        "hits": [
          {
            "hitType": "RESOURCE",
            "score": 123,
            "resource": {},
            "traversedProperties": {},
            "highlighting": {}
          }
        ],
        "meta": {
          "numPages": 123,
          "page": 123,
          "perPage": 123,
          "total": 123,
          "filter": {
            "and": "<array>",
            "id": "<string>"
          }
        },
        "aggregates": [
          {
            "type": "LEXICAL",
            "path": "<string>",
            "aggregate": [
              {
                "value": "<string>",
                "count": 123
              }
            ]
          }
        ],
        "semanticQueryInfo": {
          "reasoning": "<string>",
          "originalQuery": "<string>",
          "query": {
            "and": "<array>",
            "id": "<string>"
          },
          "filter": {
            "and": "<array>",
            "id": "<string>"
          }
        }
      }
    }
  ]
}

Authorizations

​
X-Clinia-API-Key
string
header
required

Path Parameters

​
sourceKey
string
required

The source from which to execute the query.

Body

application/json

The list of queries to execute. It is possible to send multiple query items, where each of the item can be either a regular query or a federated query.

​
requests
object[]
required

The list of queries to execute.

Response

A successful response.

The list of responses for the multi query. The responses are returned in the same order as the requests.

​
responses
object[]
required

The responses for each corresponding requests.