Official client SDKs for the webscrape.ai API.

This directory ships as the sdk/ folder of github.com/webscrape-ai/webscrape-ai and is fully self-contained.

Language Package Directory
Go github.com/webscrape-ai/webscrape-ai/sdk/go go/
Python webscrape-ai (import webscrape_ai) python/
Node / TypeScript webscrape-ai node/
Rust webscrape-ai (lib webscrape_ai) rust/
Java ai.webscrape:webscrape-sdk java/

Covered API surface

  • POST /v1/scrape — fetch a URL as HTML, cleaned markdown, or links
  • POST /v1/smartscraper — LLM structured extraction with optional JSON-schema validation
  • POST /v1/smartbrowse/recipes/{id}/run — dispatch a SmartBrowse run
  • GET /v1/smartbrowse/runs/{id} — poll a run
  • GET /v1/smartbrowse/usage — plan caps + rolling 30-day usage

Every SDK ships the same conveniences: automatic retry with exponential backoff on rate-limited and failed requests (failed requests are never charged, so retries are always safe), a run_and_wait helper that turns the SmartBrowse dispatch+poll two-step into one call, and WEBSCRAPE_API_KEY env-var pickup.

API reference

openapi.yaml is the vendored public spec; full documentation lives at webscrape.ai/docs.

Development

make all        # build + test all five SDKs
make go python node rust java   # individually

Toolchains: Go ≥ 1.22, Python ≥ 3.10, Node ≥ 18 (+pnpm), Rust stable, JDK ≥ 11 (+Maven).