View as Markdown
ScrapeGraphAI icon

ScrapeGraphAI ACTION

Start Smart Scraper

Extract content from a webpage using AI by providing a natural language prompt and a URL. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ScrapeGraphAI account once, then configure and run Start Smart Scraper from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "scrapegraphai-start-smart-scraper",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    scrapegraphai: { authProvisionId: "apn_xxxxxxx" },
    url: "URL to Scrape",
    prompt: "Prompt",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Start Smart Scraper inputs
Property Type Description
url URL to Scrape string
The URL of the website to scrape.
Required
prompt Prompt string
A prompt describing what you want to extract. Example: Extract info about the company
Required
waitForCompletion Wait For Completion boolean
Set to true to poll the API in 3-second intervals until the request is completed
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
scrapegraphai-start-smart-scraper
Version
0.0.2
App
ScrapeGraphAI
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes