Skip to main content

​
Overview

Hypermodel API is a natural language query API that processes business dataset requests and delivers enriched data to various destinations. Transform natural language queries like “Find the top 10 Series A companies that sell to the hospitality industry” into structured, enriched business data delivered to your preferred destination.

​
Features

  • Natural Language Processing: Uses Claude AI to parse and understand complex data queries
  • Data Extraction & Enrichment: Automatically extracts and enriches data based on query requirements using Hypermodel and web search
  • Multiple Destinations: Supports URL webhooks, Snowflake, Google Sheets, and Clay
  • Async Processing: Uses Temporal workflows for reliable async processing
  • RESTful API: Simple HTTP endpoints for query submission and status tracking
  • Synchronous & Asynchronous Modes: Choose between immediate results or background processing

​
Quick Start

Get started in under 5 minutes:
  1. Get your API key: Contact us to get your API key
  2. Submit a query: Use the /api/v1/query endpoint to process natural language queries
  3. Receive results: Get enriched data delivered to your chosen destination or synchronously

Getting Started

Learn how to make your first API call

API Reference

Complete API endpoint documentation

​
How It Works

​
Synchronous Mode (Default)

Submit a query and receive results immediately in the response: 
POST /api/v1/query
{
  "query": "Find 5 Series A fintech companies with CEO contact info",
  "schema": { /* JSON Schema for response format */ },
  "async": false
}
Returns enriched data directly in the response.

​
Asynchronous Mode

Submit a query for background processing and delivery to a destination: 
POST /api/v1/query
{
  "query": "Find 10 Series A companies in hospitality",
  "schema": { /* JSON Schema for response format */ },
  "destination": {
    "type": "URL",
    "config": {
      "endpoint": "https://your-webhook.com/receive"
    }
  },
  "async": true
}
Returns a query ID to track status, with results delivered to the destination when complete.

​
Processing Pipeline

The Hypermodel API:
  1. Parses your natural language query using AI
  2. Extracts and enriches data using Hypermodel and web search
  3. Formats responses to match your JSON schema
  4. Delivers data to your chosen destination (URL, Snowflake, Sheets, or Clay)
  5. Provides reliable async processing with automatic retries

​
Authentication

All API endpoints require authentication via the X-API-Key header: 
curl -X POST https://api.hypermodel.ai/api/v1/query \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{ "query": "...", "schema": {...} }'
⌘I