JavaScript / TypeScript SDK

First-class TypeScript types — every response shape inferred. Works in Node 18+, Deno, Bun, and browsers (CORS permitting). Ships as an ES module so tree-shaking just works.

Not yet published. The JavaScript / TypeScript client library lands alongside public launch. Beta users using JavaScript / TypeScript can preview the API shape below and help us shape the final interface — email hello@syttra.com.

Install

$npm install @syttra/sdk

What the API will look like

Draft — subject to change based on beta feedback. The goal: one line to authenticate, one line to scrape, typed responses throughout.

typescript

import { Syttra } from "@syttra/sdk";

const client = new Syttra({ apiKey: process.env.SYTTRA_API_KEY });

// Single page, fully typed response
const job = await client.scrape({
  url: "https://example.com",
  format: "markdown",
});
console.log(job.result.content.slice(0, 200));

// Full-site crawl with streaming
const crawl = await client.scrape({
  url: "https://docs.example.com",
  mode: "full",
  maxDepth: 3,
});
for await (const page of crawl.pages()) {
  console.log(page.url, page.content.length);
}

Meanwhile — use the REST API

Everything the SDK will do, the REST API already does. Plain HTTP + JSON, works from any language.

Read the REST docs