Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bulkgrid.com/llms.txt

Use this file to discover all available pages before exploring further.

Use crawl when you already know which URLs you want Bulkgrid to process.

​
Request

curl "$BULKGRID_BASE_URL/api/v1/crawl" \
  -H 'Content-Type: application/json' \
  -H "x-api-key: $BULKGRID_API_KEY" \
  -d '{
    "urls": [
      "https://example.com/docs",
      "https://example.com/pricing"
    ],
    "options": {
      "formats": ["markdown", "cleanHtml"],
      "timeout": 30000,
      "blockAds": true,
      "useInteractions": true
    }
  }'

​
What happens next

Bulkgrid creates a crawl run and begins processing the URLs. When the run completes, result records can include generated markdown, clean HTML, raw HTML, links, and screenshot-related fields.

​
Next step

Read Crawl and Fetch Results.