|
11 | 11 |
|
12 | 12 | Official Python SDK for the [ScrapeGraphAI API](https://scrapegraphai.com). |
13 | 13 |
|
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 | | - |
41 | 14 | ## Install |
42 | 15 |
|
43 | 16 | ```bash |
@@ -72,6 +45,32 @@ class ApiResult(Generic[T]): |
72 | 45 | error: str | None |
73 | 46 | elapsed_ms: int |
74 | 47 | ``` |
| 48 | +## 🆚 Open Source vs Managed API |
| 49 | + |
| 50 | +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. |
| 51 | + |
| 52 | +| | Open Source (`scrapegraphai`) | Managed API (this SDK) | |
| 53 | +|---|---|---| |
| 54 | +| **What it is** | A Python library you run yourself | A hosted cloud service you call via SDK | |
| 55 | +| **Where it runs** | Your own infrastructure (self-hosted) | ScrapeGraphAI cloud | |
| 56 | +| **LLM** | Bring your own (OpenAI, Groq, Gemini, Azure, local via Ollama) | Managed for you | |
| 57 | +| **Browser / JS rendering** | You configure it (Playwright) | Managed (stealth, `auto`/`fast`/`js` modes) | |
| 58 | +| **Proxies & anti-bot** | Your responsibility | Included | |
| 59 | +| **Scaling & maintenance** | Your responsibility | Fully managed | |
| 60 | +| **Cost model** | LLM tokens + your own infra | Pay-as-you-go credits | |
| 61 | +| **Auth** | Your own LLM keys | `SGAI_API_KEY` | |
| 62 | +| **Capabilities** | Graph pipelines (SmartScraper, Search, Speech, ScriptCreator…) | Scrape, Extract, Search, Crawl, Monitor, History | |
| 63 | +| **Setup effort** | More configuration | Minimal — API key + one call | |
| 64 | +| **License** | MIT | SDK is MIT; the API service is paid | |
| 65 | + |
| 66 | +**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. |
| 67 | + |
| 68 | +**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. |
| 69 | + |
| 70 | +- Open-source library: https://github.com/ScrapeGraphAI/Scrapegraph-ai |
| 71 | +- Python SDK: https://github.com/ScrapeGraphAI/scrapegraph-py |
| 72 | +- JS/TS SDK: https://github.com/ScrapeGraphAI/scrapegraph-js |
| 73 | +- API docs: https://docs.scrapegraphai.com/introduction |
75 | 74 |
|
76 | 75 | ## API |
77 | 76 |
|
|
0 commit comments