Skip to main content
POST
/
query
Query data
curl --request POST \
  --url https://api.datalinks.com/api/v1/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "namespace": "<string>",
  "dataset": "<string>",
  "query": "",
  "naturalLanguageQuery": "<string>",
  "model": "<string>",
  "provider": "<string>",
  "explainRequested": true
}
'
{
  "data": [
    {}
  ],
  "metadata": {
    "count": 123,
    "executedQuery": "<string>",
    "originalQuery": "<string>",
    "startingDataset": "<string>",
    "finalDataset": "<string>"
  },
  "explainResults": {
    "id": "<string>",
    "datasetIdToCount": {},
    "start": "2023-11-07T05:31:56Z",
    "durationNs": 123,
    "children": "<array>"
  }
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token for authentication. Submit the token using the Authorization header: Authorization: Bearer <token>.

Body

application/json
​
username
string
required
​
namespace
string
required
​
dataset
string
​
query
string
default:""
​
naturalLanguageQuery
string
​
model
string
​
provider
string
​
explainRequested
boolean

Response

Returns query results.

​
data
object[]
required

Array of ontology data objects retrieved from queries.

​
metadata
object
required
​
explainResults
object

Explain results for the query.