Skip to main content
POST
/
api
/
v1
/
query
curl -X POST https://api.hypermodel.ai/api/v1/query \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Find 5 Series A fintech companies with CEO information",
    "schema": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "company_name": { "type": "string" },
          "domain": { "type": "string" },
          "ceo_name": { "type": "string" },
          "ceo_linkedin": { "type": "string" }
        }
      }
    },
    "async": false,
    "accuracyMode": "high"
  }'

{
  "success": true,
  "data": {
    "id": "query_1234567890_abc123",
    "raw": "Raw unformatted response from Claude...",
    "data": [
      {
        "company_name": "Example Fintech",
        "domain": "example.com",
        "ceo_name": "John Doe",
        "ceo_linkedin": "https://linkedin.com/in/johndoe"
      },
      {
        "company_name": "Another Fintech",
        "domain": "another.com",
        "ceo_name": "Jane Smith",
        "ceo_linkedin": "https://linkedin.com/in/janesmith"
      }
    ]
  }
}

​
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

​
Synchronous Mode

curl -X POST https://api.hypermodel.ai/api/v1/query \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Find 5 Series A fintech companies with CEO information",
    "schema": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "company_name": { "type": "string" },
          "domain": { "type": "string" },
          "ceo_name": { "type": "string" },
          "ceo_linkedin": { "type": "string" }
        }
      }
    },
    "async": false,
    "accuracyMode": "high"
  }'

{
  "success": true,
  "data": {
    "id": "query_1234567890_abc123",
    "raw": "Raw unformatted response from Claude...",
    "data": [
      {
        "company_name": "Example Fintech",
        "domain": "example.com",
        "ceo_name": "John Doe",
        "ceo_linkedin": "https://linkedin.com/in/johndoe"
      },
      {
        "company_name": "Another Fintech",
        "domain": "another.com",
        "ceo_name": "Jane Smith",
        "ceo_linkedin": "https://linkedin.com/in/janesmith"
      }
    ]
  }
}

​
Asynchronous Mode

curl -X POST https://api.hypermodel.ai/api/v1/query \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Find 10 Series A companies that sell to the hospitality industry",
    "schema": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": { "type": "string" },
          "domain": { "type": "string" },
          "industry": { "type": "string" }
        }
      }
    },
    "destination": {
      "type": "URL",
      "config": {
        "endpoint": "https://webhook.site/your-unique-id",
        "headers": {
          "X-Custom-Header": "value"
        }
      }
    },
    "async": true
  }'

{
  "id": "query_1234567890_abc123",
  "status": "pending",
  "destination": {
    "type": "URL"
  },
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-01T00:00:00Z"
}

​
Error Responses

{
  "error": "Invalid request",
  "details": [
    {
      "code": "invalid_type",
      "path": ["schema"],
      "message": "Required"
    }
  ]
}

​
Accuracy Modes

  • Low Accuracy (Default)
  • High Accuracy
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"
}
⌘I