Merge pull request #17 from ScrapeGraphAI/v2-api-migration

feat!: migrate to ScrapeGraphAI v2 API (1.0.0)

Author: VinciGit00

.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Publish to npm
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: 'https://registry.npmjs.org'
+          cache: pnpm
+
+      - run: pnpm install --frozen-lockfile
+
+      - run: pnpm build
+
+      - run: pnpm exec eslint -c .eslintrc.prepublish.js nodes credentials package.json
+
+      - run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -4,42 +4,65 @@
   <img src="./nodes/scrapegraphAI.svg" width="250" alt="ScrapegraphAI Logo">
 </p>
 
-This is the official node for [ScrapegraphAI](https://scrapegraphai.com) for n8n. It allows you to use ScrapegraphAI's powerful web scraping and data extraction capabilities within your n8n workflows.
+The official [ScrapeGraphAI](https://scrapegraphai.com) node for n8n. Hits the v2 API at `https://v2-api.scrapegraphai.com/api`.
 
-## Installation
-
-You can install this node in your n8n instance as follows:
-
-1. Go to **Settings** in your n8n instance
-2. Select the **Community Nodes** tab
-3. Click on **Install**
-4. Enter `n8n-nodes-scrapegraphai` in the "npm package name" field
-5. Click **Install**
+> **1.0.0 is a breaking release.** v1 endpoints (`/v1/smartscraper`, `/v1/markdownify`, `/v1/agentic-scrapper`, `/v1/toonify`) are gone. See **Migrating from 0.x** below.
 
-After installation, you will be able to use the ScrapegraphAI nodes in your workflows.
-
-## Features
-
-This node provides several operations to interact with the ScrapegraphAI API:
+## Installation
 
-- Markdownify - Convert a webpage to markdown
-- Smart Scraper - Extract specific data from a webpage
-- Search Scraper - Extract data from search results
+1. In n8n, go to **Settings → Community Nodes → Install**
+2. Enter `n8n-nodes-scrapegraphai`
+3. Click **Install**
 
 ## Credentials
 
-To use this node, you need a ScrapegraphAI API key. You can get one by signing up at [scrapegraphai.com](https://scrapegraphai.com) and visiting your [dashboard](https://dashboard.scrapegraphai.com/dashboard).
-
-<img width="1360" alt="image" src="https://github.com/user-attachments/assets/c4305f4d-a7bd-445a-a495-a1e0314b4f46" />
-
-
-## Usage
-
-After adding the node to your workflow, you'll need to:
-
-1. Create new credentials and enter your ScrapegraphAI API key
-2. Choose the operation you want to perform
-3. Configure the required parameters (e.g., website URL, extraction rules)
+1. Sign up at [scrapegraphai.com](https://scrapegraphai.com) and grab a key from the [dashboard](https://scrapegraphai.com/dashboard).
+2. In n8n, create a new **ScrapegraphAI API** credential and paste the key.
+3. n8n will validate the key against `GET /api/credits` — a green check means it's good.
+
+## Resources
+
+| Resource | Operations | What it does |
+|----------|------------|--------------|
+| **Scrape** | Scrape | Fetch a URL in any combination of formats: markdown, HTML, links, images, summary, JSON extraction, branding, or screenshot. |
+| **Extract** | Extract | LLM-powered structured extraction from a URL, raw HTML, or markdown. Optional JSON schema. |
+| **Search** | Search | Web search with content fetched inline. Optional AI rollup across all results. |
+| **Crawl** | Start, Get Status, Stop, Resume, Delete | Async multi-page crawl with include/exclude URL patterns. |
+| **Monitor** | Create, Get, Get Many, Get Activity, Update, Pause, Resume, Delete | Cron-scheduled fetches with change detection and webhooks. |
+| **History** | Get, Get Many | Look up past requests by ID — including the formatted content of crawled pages via each `scrapeRefId`. |
+| **Credit** | Get | Remaining credits, plan, and crawl/monitor quotas. |
+
+Every fetch-based resource shares the same **Fetch Config** options: `mode` (auto / fast / js), `stealth`, `scrolls`, `wait`, `timeout`, `country`, custom `headers`, custom `cookies`.
+
+## Migrating from 0.x
+
+Three resources were removed in v2 — the API endpoints behind them are gone:
+
+| Removed in 1.0.0 | Replacement |
+|------------------|-------------|
+| Markdownify | **Scrape** with format `markdown` |
+| Agentic Scraper | **Extract** with `Fetch Config → Mode = JS` and `Stealth = true` for hard pages, or **Crawl** for multi-page flows |
+| Toonify | The open-source [`toonify`](https://github.com/ScrapeGraphAI/toonify) package — TOON is no longer an API endpoint |
+
+Field renames (top-level → v2):
+
+| 0.x field | 1.0.0 location |
+|-----------|----------------|
+| `website_url` | `url` |
+| `user_prompt` | `prompt` (extract) / `query` (search) |
+| `output_schema` | `schema` |
+| `render_heavy_js` | `Fetch Config → Mode = JS` |
+| `stealth` | `Fetch Config → Stealth` |
+| `wait_ms` | `Fetch Config → Wait (Ms)` |
+| `number_of_scrolls` | `Fetch Config → Scrolls` |
+| `country_code` | `Fetch Config → Country` (most) / `Location (Country Code)` (search) |
+| `time_range` | `Time Range` (search) |
+
+Removed without replacement:
+
+- `total_pages` — use the **Crawl** resource for multi-page work.
+- `mock` — gone in v2; mock at the n8n / HTTP layer if you need it.
+- `cache_website`, `same_domain_only`, `breadth` (crawl) — use `includePatterns` / `excludePatterns` / `maxLinksPerPage` / `maxDepth` instead.
 
 ## License
 

credentials/ScrapegraphAIAPi.credentials.ts

@@ -33,14 +33,13 @@ export class ScrapegraphAIApi implements ICredentialType {
 
 	test: ICredentialTestRequest = {
 		request: {
-			baseURL: 'https://api.scrapegraphai.com/v1',
-			url: '/validate',
+			baseURL: 'https://v2-api.scrapegraphai.com/api',
+			url: '/credits',
 			method: 'GET',
 			headers: {
-				'Content-Type': 'application/json',
 				'SGAI-APIKEY': '={{$credentials.apiKey}}',
 				'User-Agent': 'n8n',
-			}
+			},
 		},
 	};
 }