SDKs

Typed clients for your application runtime.

The official clients mirror the HTTP API while adding typed responses, sensible retries, and job helpers for the workflows you run every day.

Install the recommended SDK

Use the official Node.js client for server routes, workers, and backend services. It is the fastest path from your first request to a durable crawl workflow.

RECOMMENDED

Official Node.js client

Install package
npm install @basecrawl/sdk

Create a typed client

Pass the API key from your environment and await a crawl job when your workflow needs the complete site result.

Create client
import { Basecrawl } from "@basecrawl/sdk";

const basecrawl = new Basecrawl({
  apiKey: process.env.BASECRAWL_API_KEY,
});

const crawl = await basecrawl.crawl({
  url: "https://docs.example.com",
  maxDepth: 2,
  formats: ["markdown"],
});

const job = await basecrawl.crawls.waitForCompletion(crawl.id);

Alternative SDKs

One document model, every runtime.

SDKs intentionally return the same fields as direct HTTP. Move between quick experiments and production services without rewriting your data contracts.

KEEP EXPLORING

OverviewChoose a focused path into the Basecrawl platform.QuickstartMake your first request in under two minutes.API referenceRequest conventions, authentication, and response shapes.CrawlDiscover and extract an entire site.ScrapeExtract clean content from a single page.