scrapegraphai.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.
Account
credits
account.credits
Get remaining and used credit balance
Risk: read
usageTimeline
account.usageTimeline
Get a timeline of past request usage
Risk: read
Output
timeline full type
timeline full type
validateApiKey
account.validateApiKey
Validate that the configured API key is active
Risk: read
Agentic Scraper
getLiveSessionUrl
agenticScraper.getLiveSessionUrl
Open a live, remotely-controllable browser session for a URL
Risk: write
Output
history
agenticScraper.history
List past agentic (browser-driven) scraper requests
Risk: read
Output
requests full type
requests full type
Endpoint
getSuggestions
endpoint.getSuggestions
Analyze a webpage and suggest reusable scraping endpoint configs (spends credits)
Risk: write
Output
suggestions full type
suggestions full type
save
endpoint.save
Save custom scraping endpoint configurations
Risk: write
suggestions full type
suggestions full type
Feedback
submit
feedback.submit
Submit a rating/feedback for a completed request
Risk: write
Output
submitProduct
feedback.submitProduct
Submit general product feedback
Risk: write
Output
Markdownify
history
markdownify.history
List past Markdownify requests
Risk: read
Output
requests full type
requests full type
start
markdownify.start
Start converting a webpage to clean Markdown (async, spends credits)
Risk: write
Output
status
markdownify.status
Get status and results for a Markdownify job
Risk: read
Output
Scheduled Jobs
list
scheduledJobs.list
List scheduled recurring scraping jobs
Risk: read
Output
jobs full type
jobs full type
Schema
generate
schema.generate
Generate or refine a JSON schema from a natural-language prompt (spends credits)
Risk: write
Output
Scrape
history
scrape.history
List past single-page Scrape requests
Risk: read
Output
requests full type
requests full type
Search Scraper
history
searchScraper.history
List past SearchScraper requests
Risk: read
Output
requests full type
requests full type
start
searchScraper.start
Start an AI-powered web search job (async, spends credits)
Risk: write
Output
status
searchScraper.status
Get status and results for a SearchScraper job
Risk: read
Output
Sitemap
history
sitemap.history
List past sitemap generation requests
Risk: read
Output
requests full type
requests full type
Smart Crawler
history
smartCrawler.history
List past SmartCrawler requests
Risk: read
Output
requests full type
requests full type
start
smartCrawler.start
Start a multi-page crawl of a site with optional AI extraction (async, spends credits)
Risk: write
rules full type
rules full type
status
smartCrawler.status
Get status and results for a SmartCrawler job
Risk: read
Output
webhookLogs
smartCrawler.webhookLogs
Get webhook delivery logs for a SmartCrawler job
Risk: read
Output
Smart Scraper
history
smartScraper.history
List past SmartScraper requests
Risk: read
Output
requests full type
requests full type
start
smartScraper.start
Start an AI-powered structured extraction job for a webpage (async, spends credits)
Risk: write
Output
status
smartScraper.status
Get status and results for a SmartScraper job
Risk: read
Output
Utilities
toonify
utilities.toonify
Convert JSON to TOON (Token-Oriented Object Notation) to reduce LLM token usage
Risk: read
Output:
string \| object
Output full type
Output full type