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 extraction when you want structured output instead of raw crawled content.

​
Request

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 a one sentence product summary",
    "schema": {
      "type": "object",
      "properties": {
        "companyName": { "type": "string" },
        "productSummary": { "type": "string" }
      },
      "required": ["companyName"]
    }
  }'

​
What happens next

Bulkgrid returns a run object immediately. Extraction is asynchronous.

​
Minimal response fields to store

  • id
  • status
  • type
  • urls
  • created_at

​
Next step

Poll GET /api/v1/runs/{runId} until the run reaches completed, then call GET /api/v1/runs/{runId}/results. For the full workflow, read Extraction.