POST
/
v1
/
smartscraper

SmartScraper allows you to extract specific information from any webpage using AI. Simply provide a URL and describe what information you want to extract in natural language.

​
Use Cases

  • Extract company information from websites
  • Gather product details from e-commerce pages
  • Collect contact information from business pages
  • Extract structured data from articles or blog posts

​
Example Response

{
  "request_id": "<request-id>",
  "status": "completed",
  "website_url": "https://scrapegraphai.com/",
  "user_prompt": "Extract info about the company",
  "result": {
    "company_name": "ScrapeGraphAI",
    "description": "ScrapeGraphAI is a powerful AI scraping API designed for efficient web data extraction to power LLM applications and AI agents...",
    "features": [
      "Effortless, cost-effective, and AI-powered data extraction",
      "Handles proxy rotation and rate limits",
      "Supports a wide variety of websites"
    ],
    "contact_email": "contact@scrapegraphai.com",
    "social_links": {
      "github": "https://github.com/ScrapeGraphAI/Scrapegraph-ai",
      "linkedin": "https://www.linkedin.com/company/101881123",
      "twitter": "https://x.com/scrapegraphai"
    },
    "..."
  },
  "error": ""
}

Authorizations

​
SGAI-APIKEY
string
header
required

Body

application/json
​
user_prompt
string
required
​
website_url
string
required
​
output_schema
object | null

Response

200 - application/json
​
request_id
string
required
​
status
enum<string>
required
Available options:
queued,
processing,
completed,
failed
​
user_prompt
string
required
​
website_url
string
required
​
error
string
default:
​
result
object | null

Was this page helpful?

Error HandlingGet SmartScraper Status