Skip to content

Commit 3703f8c

Browse files
docs: reorganize examples table by service, add SGAI_API_KEY env var
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 0738786 commit 3703f8c

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

README.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -202,31 +202,32 @@ const health = await checkHealth("key");
202202

203203
## Examples
204204

205-
| Path | Description |
206-
|------|-------------|
207-
| [`scrape/scrape_basic.ts`](examples/scrape/scrape_basic.ts) | Basic markdown scraping |
208-
| [`scrape/scrape_multi_format.ts`](examples/scrape/scrape_multi_format.ts) | Multiple formats (markdown, links, images, screenshot, summary) |
209-
| [`scrape/scrape_json_extraction.ts`](examples/scrape/scrape_json_extraction.ts) | Structured JSON extraction with schema |
210-
| [`scrape/scrape_pdf.ts`](examples/scrape/scrape_pdf.ts) | PDF document parsing with OCR metadata |
211-
| [`scrape/scrape_with_fetchconfig.ts`](examples/scrape/scrape_with_fetchconfig.ts) | JS rendering, stealth mode, scrolling |
212-
| [`extract/extract_basic.ts`](examples/extract/extract_basic.ts) | AI data extraction from URL |
213-
| [`extract/extract_with_schema.ts`](examples/extract/extract_with_schema.ts) | Extraction with JSON schema |
214-
| [`search/search_basic.ts`](examples/search/search_basic.ts) | Web search with results |
215-
| [`search/search_with_extraction.ts`](examples/search/search_with_extraction.ts) | Search + AI extraction |
216-
| [`crawl/crawl_basic.ts`](examples/crawl/crawl_basic.ts) | Start and monitor a crawl |
217-
| [`crawl/crawl_with_formats.ts`](examples/crawl/crawl_with_formats.ts) | Crawl with screenshots and patterns |
218-
| [`monitor/monitor_basic.ts`](examples/monitor/monitor_basic.ts) | Create a page monitor |
219-
| [`monitor/monitor_with_webhook.ts`](examples/monitor/monitor_with_webhook.ts) | Monitor with webhook notifications |
220-
| [`schema/generate_schema_basic.ts`](examples/schema/generate_schema_basic.ts) | Generate JSON schema from prompt |
221-
| [`schema/modify_existing_schema.ts`](examples/schema/modify_existing_schema.ts) | Modify an existing schema |
222-
| [`utilities/credits.ts`](examples/utilities/credits.ts) | Check account credits and limits |
223-
| [`utilities/health.ts`](examples/utilities/health.ts) | API health check |
224-
| [`utilities/history.ts`](examples/utilities/history.ts) | Request history |
205+
| Service | Example | Description |
206+
|---------|---------|-------------|
207+
| scrape | [`scrape_basic.ts`](examples/scrape/scrape_basic.ts) | Basic markdown scraping |
208+
| scrape | [`scrape_multi_format.ts`](examples/scrape/scrape_multi_format.ts) | Multiple formats (markdown, links, images, screenshot, summary) |
209+
| scrape | [`scrape_json_extraction.ts`](examples/scrape/scrape_json_extraction.ts) | Structured JSON extraction with schema |
210+
| scrape | [`scrape_pdf.ts`](examples/scrape/scrape_pdf.ts) | PDF document parsing with OCR metadata |
211+
| scrape | [`scrape_with_fetchconfig.ts`](examples/scrape/scrape_with_fetchconfig.ts) | JS rendering, stealth mode, scrolling |
212+
| extract | [`extract_basic.ts`](examples/extract/extract_basic.ts) | AI data extraction from URL |
213+
| extract | [`extract_with_schema.ts`](examples/extract/extract_with_schema.ts) | Extraction with JSON schema |
214+
| search | [`search_basic.ts`](examples/search/search_basic.ts) | Web search with results |
215+
| search | [`search_with_extraction.ts`](examples/search/search_with_extraction.ts) | Search + AI extraction |
216+
| crawl | [`crawl_basic.ts`](examples/crawl/crawl_basic.ts) | Start and monitor a crawl |
217+
| crawl | [`crawl_with_formats.ts`](examples/crawl/crawl_with_formats.ts) | Crawl with screenshots and patterns |
218+
| monitor | [`monitor_basic.ts`](examples/monitor/monitor_basic.ts) | Create a page monitor |
219+
| monitor | [`monitor_with_webhook.ts`](examples/monitor/monitor_with_webhook.ts) | Monitor with webhook notifications |
220+
| schema | [`generate_schema_basic.ts`](examples/schema/generate_schema_basic.ts) | Generate JSON schema from prompt |
221+
| schema | [`modify_existing_schema.ts`](examples/schema/modify_existing_schema.ts) | Modify an existing schema |
222+
| utilities | [`credits.ts`](examples/utilities/credits.ts) | Check account credits and limits |
223+
| utilities | [`health.ts`](examples/utilities/health.ts) | API health check |
224+
| utilities | [`history.ts`](examples/utilities/history.ts) | Request history |
225225

226226
## Environment Variables
227227

228228
| Variable | Description | Default |
229229
|----------|-------------|---------|
230+
| `SGAI_API_KEY` | Your ScrapeGraph API key ||
230231
| `SGAI_API_URL` | Override API base URL | `https://api.scrapegraphai.com/v2` |
231232
| `SGAI_DEBUG` | Enable debug logging (`"1"`) | off |
232233
| `SGAI_TIMEOUT_S` | Request timeout in seconds | `120` |

0 commit comments

Comments
 (0)