> ## Documentation Index
> Fetch the complete documentation index at: https://bulkgrid.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference Overview

> How the Bulkgrid API is organized and how to use the generated reference effectively.

The Bulkgrid API currently exposes five main areas:

* search
* extraction
* crawl and deep crawl
* runs
* results and result content

## Endpoint groups

<CardGroup cols={3}>
  <Card title="Search" icon="search" href="/api-reference/search-endpoints">
    Ranked retrieval over indexed content.
  </Card>

  <Card title="Extraction" icon="braces" href="/api-reference/extraction-endpoints">
    Structured data extraction workflows.
  </Card>

  <Card title="Crawling" icon="bug" href="/api-reference/crawl-endpoints">
    Crawl and deep crawl run creation.
  </Card>

  <Card title="Runs" icon="play" href="/api-reference/runs-endpoints">
    Status inspection, retry, cancel, and management.
  </Card>

  <Card title="Results" icon="file-text" href="/api-reference/results-endpoints">
    Result listing and content retrieval.
  </Card>
</CardGroup>

The current OpenAPI source used for the Mintlify reference lives at [openapi.json](/api-reference/openapi.json).

## How to use this section

Use the API Reference when you need:

* exact request fields
* response shapes
* status codes
* path and query parameters
* auth requirements for a specific endpoint

Use the guides when you need:

* workflow explanations
* polling patterns
* retry and operational guidance
* customer-facing examples and integration recommendations

## Authentication

All current endpoints require `x-api-key` header authentication.