Skip to main content
There are two good ways to evaluate Bulkgrid.

​
Path 1: Use the Playground first

Use the dashboard Playground if you want to validate the product before writing integration code. The Playground supports:
  • Crawl
  • Deep Crawl
  • Extract
  • Search
Read Playground Quickstart.

​
Path 2: Use the API first

Use the API-first path if you already know you want to integrate Bulkgrid programmatically.

​
1. Set environment variables

export BULKGRID_API_KEY='bg_live_your_api_key'
export BULKGRID_BASE_URL='https://your-bulkgrid-base-url'

​
2. Make your first search request

curl "$BULKGRID_BASE_URL/api/v1/search" \
  -H 'Content-Type: application/json' \
  -H "x-api-key: $BULKGRID_API_KEY" \
  -d '{
    "query": "Bulkgrid documentation",
    "limit": 5
  }'

​
3. Create an extraction run

curl "$BULKGRID_BASE_URL/api/v1/extract" \
  -H 'Content-Type: application/json' \
  -H "x-api-key: $BULKGRID_API_KEY" \
  -d '{
    "urls": ["https://example.com"],
    "query": "Extract the company name and product summary",
    "schema": {
      "type": "object",
      "properties": {
        "companyName": { "type": "string" },
        "productSummary": { "type": "string" }
      }
    }
  }'

​
4. Poll the run and fetch results

  • GET /api/v1/runs/{runId}
  • GET /api/v1/runs/{runId}/results