POST
/
api
/
collections
/
data
/
fetch
/
natural-query
curl --request POST \
  --url https://api.worqhat.com/api/collections/data/fetch/natural-query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "collection": "Users",
  "query": "Fetch all the users with age greater than 18",
  "outputType": "json"
}'
{
  "status": "success",
  "processing_time": 888,
  "processing_id": "4b139bfe-1f71-4345-b539-fa6c1700f166",
  "processing_count": 6554,
  "data": {
    "databaseId": "1234567890",
    "collection": "Users",
    "elapsed_time": 800,
    "data": [
      {
        "sampleDbContent": "This is a sample content",
        "sampleDbContent2": "This is a sample content 2"
      },
      {
        "sampleDbContent": "This is a sample content",
        "sampleDbContent2": "This is a sample content 2"
      }
    ]
  }
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
collection
string

The Name of the Collection or the Group where you want to store all your data.

query
string

The Query that you want to run on the Collection. Describe the data that you want to fetch from a Collection in a natural language format and we will run the query for you.

outputType
enum<string>

The type of output you want. json will return the data as a JSON object that is parseable. stream will return the data as a stream of data and file will return the data as a parseable CSV file.

Available options:
json,
stream,
file

Response

200 - application/json
status
string

Status indicating the success of the text moderation.

processing_time
integer

The time taken to process the request, in milliseconds.

processing_id
string

A universally unique identifier for the request. This can be used to track the request in the logs.

processing_count
integer

The number of times the request has been processed. This is what is considered in the Billing Process. This is either the number of times the image is processed or the number of words that the server processes.

data
object