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

# Introduction

> Add a source and make your first search with Bulkgrid.

Bulkgrid turns websites and GitHub repositories into searchable knowledge for your applications and AI agents.

## 1. Add a source

Open [Sources](https://bulkgrid.com/dashboard/sources) in your workspace and add a website or GitHub repository. Start with a small source or a focused section, then wait for its documents to finish indexing.

Already have indexed sources? Use one of those for the next step.

## 2. Try a search

Open the dashboard **Playground**, choose **Search**, and ask a question about your source. The results contain relevant passages and their source URLs.

If no results appear, check that indexing has finished and that the source is accessible to your workspace. See [Sources](https://bulkgrid.com/docs/sources.md) for help.

## 3. Connect your application or agent

Choose how you want to use Bulkgrid:

> **[SDK](https://bulkgrid.com/docs/sdk.md)**
>
> Search and manage sources from your application.

> **[CLI](https://bulkgrid.com/docs/cli.md)**
>
> Manage sources and configure AI clients from your terminal.

> **[MCP](https://bulkgrid.com/docs/mcp-server.md)**
>
> Let your AI agent search your indexed content.

### Connect your coding agent

Choose your agent for setup and browser sign-in:

![](https://mintcdn.com/bulkgridab/ppj07ROe5VDEpIYx/logo/clients/codex.svg?fit=max\&auto=format\&n=ppj07ROe5VDEpIYx\&q=85\&s=67aa724184d8ca5456e8ace684cb590a)

Codex

[Open](https://bulkgrid.com/docs/mcp-server.md#client-setup)

![](https://mintcdn.com/bulkgridab/ppj07ROe5VDEpIYx/logo/clients/claude.svg?fit=max\&auto=format\&n=ppj07ROe5VDEpIYx\&q=85\&s=7cfdd161fc021272fa28e17318708edb)

Claude Code

[Open](https://bulkgrid.com/docs/mcp-server.md#client-setup)

![](https://mintcdn.com/bulkgridab/ppj07ROe5VDEpIYx/logo/clients/cursor.svg?fit=max\&auto=format\&n=ppj07ROe5VDEpIYx\&q=85\&s=083070ed5d885c6abab79b3508ce4dbc)

Cursor

[Open](https://bulkgrid.com/docs/mcp-server.md#client-setup)

![](https://mintcdn.com/bulkgridab/ppj07ROe5VDEpIYx/logo/clients/opencode.svg?fit=max\&auto=format\&n=ppj07ROe5VDEpIYx\&q=85\&s=810ab23e0b5a220de359a3a72d2eca1d)

OpenCode

[Open](https://bulkgrid.com/docs/mcp-server.md#client-setup)

### Call the API directly

Create an API key with `search:query` in [Settings → API Keys](https://bulkgrid.com/dashboard/settings/api-keys). Workspace owners and admins can create keys. Keep your key in your backend environment.

```bash theme={null}
export BULKGRID_API_KEY='bg_live_your_api_key'
```

Node.js and Python examples use the [Bulkgrid SDKs](https://bulkgrid.com/docs/sdk.md). Set `BULKGRID_API_KEY` in your backend environment; cURL examples also use `BULKGRID_BASE_URL=https://bulkgrid.com`.

```js Node.js theme={null}
import { BulkgridClient } from '@bulkgrid/sdk';

const client = new BulkgridClient({
  apiKey: process.env.BULKGRID_API_KEY ?? '',
  baseUrl: process.env.BULKGRID_BASE_URL ?? 'https://bulkgrid.com',
});

const data = await client.index.search({
  query: 'How do I get started?',
  limit: 3,
});
console.log(data);
```

```python Python theme={null}
import os
from bulkgrid import BulkgridClient

with BulkgridClient(
    api_key=os.environ["BULKGRID_API_KEY"],
    base_url=os.environ.get("BULKGRID_BASE_URL", "https://bulkgrid.com"),
) as client:
    data = client.index.search({"query": "How do I get started?", "limit": 3})
    print(data)
```

```bash cURL theme={null}
curl 'https://bulkgrid.com/api/v1/index/search' \
  -H 'Content-Type: application/json' \
  -H "x-api-key: $BULKGRID_API_KEY" \
  -d '{
    "query": "How do I get started?",
    "limit": 3
  }'
```

Replace the query with a question your source can answer. Read the passages in `results` and follow their `url` fields to the original pages.

For access settings, see [Authentication](https://bulkgrid.com/docs/authentication.md). To process individual URLs without creating a searchable source, see [Crawl](https://bulkgrid.com/docs/crawl.md) or [Extraction](https://bulkgrid.com/docs/extraction.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.