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

# Quick Start

> Get started with the Hypermodel API in minutes

## Prerequisites

* **API Key**: Get in touch with us to get your API key [here](https://cal.com/jatin-hypermodel/30min)

## Your First Query

#### Synchronous Query (Immediate Results)

Submit a query and get results back immediately:

```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": "Find 5 Series A fintech companies",
    "schema": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": { "type": "string" },
          "domain": { "type": "string" },
          "description": { "type": "string" }
        }
      }
    },
    "async": false
  }'
```

<ResponseExample>
  ```json Response theme={null}
  {
    "success": true,
    "data": {
      "id": "query_1234567890_abc123",
      "raw": "...",
      "data": [
        {
          "name": "Example Fintech Co",
          "domain": "example.com",
          "description": "A fintech company"
        }
      ]
    }
  }
  ```
</ResponseExample>

#### Asynchronous Query (Background Processing)

Submit a query for background processing with delivery to a destination:

```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": "Find 10 Series A companies that sell to hospitality",
    "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"
      }
    },
    "async": true
  }'
```

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "query_1234567890_abc123",
    "status": "pending",
    "destination": {
      "type": "URL"
    },
    "createdAt": "2025-01-01T00:00:00Z",
    "updatedAt": "2025-01-01T00:00:00Z"
  }
  ```
</ResponseExample>

#### Check Query Status

```bash theme={null}
curl -X GET https://api.hypermodel.ai/api/v1/query/query_1234567890_abc123 \
  -H "X-API-Key: your-api-key"
```

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "query_1234567890_abc123",
    "status": "completed",
    "destination": {
      "type": "URL",
      "url": "https://webhook.site/your-unique-id"
    },
    "error": null,
    "createdAt": "2025-01-01T00:00:00Z",
    "updatedAt": "2025-01-01T00:01:00Z"
  }
  ```
</ResponseExample>

## Understanding the Schema Parameter

The `schema` parameter is **required** and defines the structure of the response data. It must be a valid JSON Schema.

<CodeGroup>
  ```json Simple Object theme={null}
  {
    "type": "object",
    "properties": {
      "name": { "type": "string" },
      "domain": { "type": "string" }
    }
  }
  ```

  ```json Array of Objects theme={null}
  {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "company_name": { "type": "string" },
        "ceo_name": { "type": "string" },
        "ceo_linkedin": { "type": "string" }
      }
    }
  }
  ```
</CodeGroup>

## Accuracy Modes

The API supports two accuracy modes:

<AccordionGroup>
  <Accordion title="Low Accuracy (Default)" icon="gauge-low">
    Uses Hypermodel first, falls back to web search if needed

    * Faster processing
    * Lower cost
    * Good for well-indexed company data
  </Accordion>

  <Accordion title="High Accuracy" icon="gauge-high">
    Uses both Hypermodel and web search in parallel for maximum accuracy

    * More comprehensive results
    * Higher accuracy
    * Slower processing and higher cost
  </Accordion>
</AccordionGroup>

```json theme={null}
{
  "query": "Find top AI companies",
  "schema": { ... },
  "accuracyMode": "high"
}
```

## Next Steps

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

  <Card title="Destination Configurations" icon="plug" href="/api-reference#destination-configurations">
    Learn about URL, Snowflake, Sheets, and Clay destinations
  </Card>
</CardGroup>