outcrawl

SDK

Outcrawl in your app. TypeScript or Python.

Ask Claude Code or Codex to add Outcrawl to your app. It installs the SDK and writes the calls; a page is 1 credit, about $0.0032 to $0.0049.

Get a free API keyRead the SDK docs

1,000 free credits every month. No card needed.

The request, as SDK sends it: import { Outcrawl } from '@outcrawl/sdk'; const oc = new Outcrawl(); // reads OUTCRAWL_API_KEY // Returns on the job frame, so the id is in hand before the first page. const crawl = await oc.crawl('https://hono.dev/docs/', { limit: 10, includePaths: ['/docs/**'], }); console.log(crawl.id, crawl.status); for await (const page of crawl) { console.log(page.depth, page.url); } // The crawl's row, read by id: where it got to and what it spent. const job = await oc.crawl.get(crawl.id); console.log(job.status, job.completed, job.credits);
Response
2005.8 s10 credits · $0.04910 pages as markdown
  1. 13.2s /docs/concepts/motivation
  2. 23.4s /docs/concepts/routers
  3. 33.6s /docs/concepts/benchmarks
  4. 43.7s /docs/concepts/web-standard
  5. 54.3s /docs/concepts/middleware
  6. 64.6s /docs/concepts/developer-experience
  7. 74.8s /docs/getting-started/basic
  8. 85.1s /docs/concepts/stacks
  9. 95.5s /docs/getting-started/cloudflare-workers-vite
  10. 105.7s /docs/getting-started/cloudflare-workers

Captured from a real call to api.outcrawl.ai on 7 October 2026.

How it works

You ask. Your agent adds it. With one install and one key.

  1. 01

    Ask for the feature.

    Tell Claude Code or Codex what your app or nightly job should do: read pages, crawl a site, send an agent to do a task.

  2. 02

    It installs the SDK.

    npm install @outcrawl/sdk or pip install outcrawl. Your key goes in OUTCRAWL_API_KEY, the same name the CLI and the MCP server read.

  3. 03

    It writes the calls and runs them.

    You review the change like any other. The code stays in your repo and runs on your own servers.

Get started in the docs
npm install @outcrawl/sdk
See the codeTypeScript SDK docs
1import { Outcrawl } from '@outcrawl/sdk';2 3const oc = new Outcrawl(); // reads OUTCRAWL_API_KEY; pass { apiKey } to override4 5const doc = await oc.scrape('https://example.com', { formats: ['markdown'] });6console.log(doc.usage); // every call returns what it cost, on the result that caused it

Node.js 20 or newer · no dependencies · MIT

What it covers

Every call in the API. In both languages.

  • oc.scrape

    Any page as markdown, JSON, HTML, links or a screenshot.

    1 call

  • oc.crawl

    A whole site, each page as it is read. Check on it, page through it or stop it by id.

    4 calls

  • oc.search

    The top results for a query, with each page already read if you ask.

    1 call

  • oc.agent

    Hand a task to an agent with a budget, watch it, answer its questions, take control or cancel it.

    12 calls

  • oc.browser

    A live browser in the cloud, handed to you as a Playwright page.

    TypeScript only

  • oc.sessions

    Every recorded session: replay, network log, console, videos and sharing.

    11 calls

  • oc.profiles

    Saved logins, so a browser or an agent starts signed in.

    4 calls

  • oc.monitors

    Pages checked on a schedule, with a webhook when they change.

    3 calls

  • oc.secrets

    Passwords, cards and billing profiles an agent types in without the model seeing them.

    5 calls

  • oc.purchases

    Every purchase your runs made, by card, site or status, in the merchant’s own currency.

    1 call

  • oc.wallet

    Your own card provider, such as Brex or Stripe Issuing, giving each run a card of its own, and the amount above which a purchase waits for a person’s yes.

    9 calls

  • oc.rules

    Plain sentences every agent run must follow.

    2 calls

  • oc.integrations

    Other MCP servers, such as Slack, that an agent run may use.

    5 calls

  • oc.credits

    Your balance and usage, as exact figures.

    2 calls

All 60 calls are named the same way in TypeScript and Python. The live browser is the one exception: it stays connected to your own process, which only the TypeScript SDK does.

Every call in the docs

Why the SDK

Less for your agent to get wrong. Than calling the API by hand.

Docs
1import { Outcrawl } from '@outcrawl/sdk';2 3const oc = new Outcrawl();4const crawl = await oc.crawl('https://example.com', { limit: 100 });5console.log(crawl.id); // store this to reach the crawl later6for await (const page of crawl) {7console.log(page.url, page.markdown);8}

What you can build

Ask once, and it runs on its own. Real examples your agent can build.

Docs

One tool, browse(task), that lets your own assistant use live websites and cite them.

example
Give my assistant a browse(task) tool with Outcrawl's TypeScript SDK, so it can use live websites and cite the pages it used. Bash(npm install @outcrawl/sdk openai): the Outcrawl SDK and the OpenAI client. Write(browse.ts): one tool that runs an agent with an answer schema and a budget. Bash(npx tsx browse.ts): an answer, with the pages it came from.

Pricing

Same credits, same rates. Billed per call.

  • Every call costs the same from the SDK, your agent, the CLI or plain HTTP.

  • A crawl bills page by page as they arrive, and an agent run never bills past its budget.

See full pricing

Tool

Dollars on

  • Scrape

    Any web page as clean markdown or JSON.

    1 credit a page

    $4.90 per 1,000 pages

  • Crawl

    Every page on a site, from one link.

    1 credit a page

    $4.90 per 1,000 pages

  • Search

    Web results for your agent. Reading a result page is 1 credit a page on top.

    5 credits per 10 results

    $2.45 per 1,000 results

  • Browsers

    A real browser in the cloud that you control.

    1 credit a minute

    about $0.29 an hour

  • Agents

    A task in plain English, done in a real browser.

    About 15 credits a minute

    about $0.07 a minute

Agent runs are billed for the AI model's usage, browser time and proxy usage, in credits. The estimate is a typical run; the actual cost depends on the task. The middle half of runs land between 10 and 25 credits a minute on Builder. Model usage converts at your plan's price per credit, so on Pro and Scale the same minute is more credits.

FAQ

Questions about the SDKs