Quickstart

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
  }'

import { BulkgridClient } from '@bulkgrid/sdk';

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

const data = await client.search({
  query: 'Bulkgrid documentation',
  limit: 5,
});

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" }
      }
    }
  }'

import { BulkgridClient } from '@bulkgrid/sdk';

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

const run = await client.extract({
  urls: ['https://example.com'],
  query: 'Extract the company name and product summary',
  schema: {
    type: 'object',
    properties: {
      companyName: { type: 'string' },
      productSummary: { type: 'string' },
    },
  },
});