Skip to content

Commit f5ddf90

Browse files
VinciGit00claude
andcommitted
docs(readme): add Open Source vs Managed API comparison
Clarify the difference between the self-hosted open-source library and this managed cloud API SDK with a comparison table and guidance. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 1d35051 commit f5ddf90

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,33 @@
1111

1212
Official TypeScript SDK for the [ScrapeGraphAI AI API](https://scrapegraphai.com).
1313

14+
## 🆚 Open Source vs Managed API
15+
16+
This SDK is a client for the **managed cloud API**. ScrapeGraphAI also ships an [open-source library](https://github.com/ScrapeGraphAI/Scrapegraph-ai) you can run yourself. This table explains the difference so you can pick the right one.
17+
18+
| | Open Source (`scrapegraphai`) | Managed API (this SDK) |
19+
|---|---|---|
20+
| **What it is** | A Python library you run yourself | A hosted cloud service you call via SDK |
21+
| **Where it runs** | Your own infrastructure (self-hosted) | ScrapeGraphAI cloud |
22+
| **LLM** | Bring your own (OpenAI, Groq, Gemini, Azure, local via Ollama) | Managed for you |
23+
| **Browser / JS rendering** | You configure it (Playwright) | Managed (stealth, `auto`/`fast`/`js` modes) |
24+
| **Proxies & anti-bot** | Your responsibility | Included |
25+
| **Scaling & maintenance** | Your responsibility | Fully managed |
26+
| **Cost model** | LLM tokens + your own infra | Pay-as-you-go credits |
27+
| **Auth** | Your own LLM keys | `SGAI_API_KEY` |
28+
| **Capabilities** | Graph pipelines (SmartScraper, Search, Speech, ScriptCreator…) | Scrape, Extract, Search, Crawl, Monitor, History |
29+
| **Setup effort** | More configuration | Minimal — API key + one call |
30+
| **License** | MIT | SDK is MIT; the API service is paid |
31+
32+
**Choose the open-source library** if you want full control, on-prem/self-hosted data, local LLMs (Ollama), or fine-grained cost tuning — and you're happy to manage browsers, proxies and scaling yourself.
33+
34+
**Choose the managed API** (this SDK) if you want zero infrastructure, managed JS rendering & anti-bot, built-in **Crawl** and scheduled **Monitor** jobs, and the fastest path to production — billed per credit.
35+
36+
- Open-source library: https://github.com/ScrapeGraphAI/Scrapegraph-ai
37+
- Python SDK: https://github.com/ScrapeGraphAI/scrapegraph-py
38+
- JS/TS SDK: https://github.com/ScrapeGraphAI/scrapegraph-js
39+
- API docs: https://docs.scrapegraphai.com/introduction
40+
1441
## Install
1542

1643
```bash

0 commit comments

Comments
 (0)