graphx-crawler

n8n community node for the GraphX Crawler API

Package Information

Released: 1 mo ago
Downloads: 0 weekly / 0 monthly
Latest Version: 0.3.0
Author: Visual GraphX

Available Nodes

Documentation generating…

GraphX Crawler icon
GraphX Crawler
Create and inspect tenant-scoped GraphX Crawler research, capture, and extraction jobs

Documentation

GraphX - Crawler

n8n community node for the GraphX Crawler API.

Operation Mapping

Resource Operation API route
Utility Health GET /api/crawler/health
Crawl Create Page Crawl POST /api/crawler/jobs/page-crawl
Crawl Create Site Crawl POST /api/crawler/jobs/site-crawl
Research Create Research Query POST /api/crawler/jobs/research-query
Extraction Create Extract Data Job POST /api/crawler/jobs/extract-data
Browser Create Browser Capture POST /api/crawler/jobs/browser-capture
Browser Map Site API POST /api/crawler/jobs/api-map
Session Create Profile POST /api/crawler/session-profiles
Session List GET /api/crawler/session-profiles
Session Get GET /api/crawler/session-profiles/:id
Session Launch Capture POST /api/crawler/session-profiles/:id/launch
Session Validate POST /api/crawler/session-profiles/:id/validate
Session Revoke POST /api/crawler/session-profiles/:id/revoke
RAG Prepare RAG Content POST /api/crawler/jobs/rag-prepare
Job List GET /api/crawler/jobs
Job Get GET /api/crawler/jobs/:id
Job Cancel POST /api/crawler/jobs/:id/cancel
Job Retry POST /api/crawler/jobs/:id/retry
Job List Artifacts GET /api/crawler/jobs/:id/artifacts
Job Create Page Crawl POST /api/crawler/jobs/page-crawl legacy location, preserved for early workflows
Artifact Get GET /api/crawler/artifacts/:id

Job Types

Job type Created by
PAGE_CRAWL Crawl > Create Page Crawl, Job > Create Page Crawl
SITE_CRAWL Crawl > Create Site Crawl
RESEARCH_QUERY Research > Create Research Query
EXTRACT_DATA Extraction > Create Extract Data Job
BROWSER_CAPTURE Browser > Create Browser Capture
API_MAP Browser > Map Site API
RAG_PREPARE RAG > Prepare RAG Content

API Mapping Output Intent

Browser > Map Site API queues browser instrumentation for a page. The runtime should capture rendered source and network transactions, then normalize discovered API calls into artifacts while redacting sensitive headers such as authorization, cookie, set-cookie, and x-api-key by default.

API Mapping Recipes

The ShopVox-Style SPA Extraction recipe is based on the ShopVox account extraction workflow:

  1. Establish an authenticated browser context from a runtime-managed session profile.
  2. Visit seed/list/detail pages that trigger the app's SPA API calls.
  3. Capture rendered page source, script references, browser storage keys, and JSON network traffic.
  4. Filter noisy endpoints such as counters, alerts, current-user, config, and tracking calls.
  5. Infer list APIs, detail APIs, record ID patterns, array keys, and pagination metadata.
  6. Probe detail subresources such as line_items, line_items_quantities, and prices.
  7. Batch-fetch records inside the browser context so cookies/session headers stay attached.
  8. Persist endpoint catalogs, extraction plans, raw samples, and quality-check artifacts.

Do not put target-site passwords or raw bearer tokens in n8n parameters. Use Session > Create Profile to create a short-lived tenant-scoped profile, then use Session > Launch Capture to request customer-assisted browser login/cookie baking. Browser > Map Site API should reference the profile as session-profile:<id> in Auth Profile Ref. The GraphX API validates that the profile belongs to the tenant, is not revoked or expired, and is only used for its allowed domains.

Session Profile Flow

  1. Create a profile with Source App, Entry URL, Allowed Domains, and a short TTL.
  2. Launch capture and send the returned profile reference to the browser/runtime layer.
  3. Validate the profile after login has been captured by the worker.
  4. Run Browser > Map Site API with Auth Strategy set to Cookie Jar / Saved Browser Session and Auth Profile Ref set to session-profile:<id>.
  5. Revoke the profile after migration or testing. Revocation clears encrypted session material and prevents future API-map jobs from using the profile.

Credentials

  • Base URL: GraphX Manage API base URL. On the DockerServer n8n stack, use http://graphx-manage-api:4000.
  • Access Token: bearer token for tenant-scoped job operations. Health checks do not require a token.

Notes

GraphX derives tenant scope from the bearer token. Do not pass tenant IDs from workflows.

Discussion