> ## 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.

# Introduction

> Use hypermodel API to query business data using natural language queries

## Overview

**Hypermodel API** is a natural language query API that processes business dataset requests and delivers enriched data to various destinations like Snowflake, Google Sheets or Clay.

Transform natural language queries like `Find the companies in the lodging & leisure industry with 10+ units` into structured, enriched business data delivered to your preferred destination.

## Features

* **Natural Language Processing**: Describe your data request in plain English and get the data you need.
* **Data Extraction & Enrichment**: Automatically extracts and enriches data based on query requirements using proprietary hypermodel native-search
* **Multiple Destinations**: Supports URL webhooks, Snowflake, Google Sheets, and Clay
* **Synchronous & Asynchronous Modes**: Choose between immediate results or background processing. Large datasets are processed asynchronously with an option to get results immediately.

## Quick Start

Get started in under 5 minutes:

1. **Get your API key**: Get in touch with us to get your API key [here](https://cal.com/jatin-hypermodel/30min)
2. **Submit a query**: Use the `/query` endpoint to fresh business data.
3. **Receive results**: Get enriched data delivered to your chosen destination or synchronously

## Quick Links

<CardGroup cols={2}>
  <Card title="Getting Started" icon="rocket" href="/quickstart">
    Learn how to make your first API call
  </Card>

  <Card title="API Reference" icon="book" href="/api-reference">
    Complete API endpoint documentation
  </Card>
</CardGroup>

## How It Works

### Synchronous Mode (Default)

Submit a query and receive results immediately in the response:

```javascript theme={null}
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:

```javascript theme={null}
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:

```bash theme={null}
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": {...} }'
```