Skip to main content
POST
/
v1
/
smart-search
Search documents
curl --request POST \
  --url https://api.bigdata.com/v1/smart-search/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "query": {
    "text": "<string>",
    "filters": {
      "timestamp": {
        "start": "<string>",
        "end": "<string>"
      }
    }
  }
}
'
{
  "usage": {
    "api_query_units": 123
  },
  "results": [],
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "metadata": {
    "request_id": "<string>",
    "timestamp": "<string>"
  }
}

Authorizations

X-API-KEY
string
header
required

Body

application/json

A public smart search request.

query
SmartSearchQuery · object
required

Response

Successful Response

Inherit mandatory fields from response and add the keys from this service

usage
QuotaUsage · object
required
results
Document · object[]
errors
ErrorDetail · object[] | null
metadata
Metadata · object