SDK

TypeScript SDK

First-class types for every Synoppy operation.

The official TypeScript SDK wraps all seven endpoints — read, crawl, map, extract, classify, enrich, images — with full type inference and editor autocomplete. Zero runtime dependencies; runs in Node, Bun, Deno, and modern edge runtimes.

Install and call it

npm install @synoppy/sdk

import { Synoppy } from "@synoppy/sdk";

const client = new Synoppy({ apiKey: process.env.SYNOPPY_API_KEY! });

const page = await client.read("https://example.com", { formats: ["markdown"] });
console.log(page.markdown);

Works with your Synoppy API key — the same key powers every capability, from a single Read call to a full crawl. Grab one from the dashboard.

Product and company names belong to their respective owners.

See the full docs

Give your agents the whole web

Read, crawl, map, extract, enrich, classify, and images are live today — all on one key. Agent actions are on the way. Build the next thing on Synoppy.

Get your API key Read the docs