Sign in

v1

latestOpenAPI 3.0.02026-07-223589127.1 KB
Scrapers

Scrape web page

Fetch a web page and return readable text plus requested markdown, HTML, links, metadata, or schema-guided JSON.

post/api/v1/platform/scrapers/web/scrape

Request body

urlstring required

URL to scrape

renderJsboolean

Render JavaScript before scraping

formatsstring[]

Output formats to return. Defaults to ["text"]. Request "json" only with jsonSchema.

jsonSchemaobject

JSON Schema used for schema-guided extraction when formats includes "json".

instructionsstring

Additional extraction instructions used only when formats includes "json".

maxAgeMsnumber

Maximum accepted cache age in milliseconds. Use 0 or omit to force a fresh scrape.

maxAgeDaysnumber

Maximum accepted cache age in days. Use 0 or omit to force a fresh scrape. Ignored when maxAgeMs is provided.

Example request

{
  "url": "https://example.com/page"
}

Response

Scraped web page content.