Skip to main content
POST
/
api
/
v1
/
query
Create Query
curl --request POST \
  --url https://api.hypermodel.ai/api/v1/query \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "query": "<string>",
  "schema": {},
  "destination": {
    "type": "<string>",
    "config": {}
  },
  "columns": [
    {}
  ],
  "async": true,
  "accuracyMode": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.hypermodel.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

​
X-API-Key
string
required
Your API key for authentication
​
Content-Type
string
default:"application/json"
Content type header

​
Body Parameters

​
query
string
required
Natural language query describing the data you want
​
schema
object
required
JSON Schema defining the structure of the response data
​
destination
object
Required when async is true. Defines where to send results
​
columns
array
Optional list of specific columns to include
​
async
boolean
default:"false"
If true, process asynchronously and send to destination
​
accuracyMode
string
default:"low"
Accuracy mode: low or high

​
Accuracy Modes

Uses Hypermodel search first, falls back to web search only if data is not found.Characteristics:
  • ⚡ Faster processing
  • 💰 Lower cost
  • 📊 Good for well-indexed company data
{
  "accuracyMode": "low"
}