Quickstart

This quickstart returns readable Markdown and HTML for a public URL.

Prerequisites

You need a PagePith account and an API key. Create a key in the PagePith dashboard.

Copy a new API key when it is created. PagePith does not display the full key again. Keep it out of client-side code and source control.

Scrape a page

Set your API key

Store the key in an environment variable.

export PAGEPITH_API_KEY="pp_live_your_key"

Send a request

Call the synchronous scrape endpoint with a public URL.

curl --request POST \
  --url https://api.pagepith.com/v1/api/scrape \
  --header "Authorization: Bearer $PAGEPITH_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"url":"https://example.com"}'

Use the result

Read markdown for model-ready text or html when you need the extracted markup.

{
  "url": "https://example.com",
  "finalUrl": "https://example.com/",
  "title": "Example Domain",
  "markdown": "# Example Domain\n\nThis domain is for use in illustrative examples...",
  "html": "<h1>Example Domain</h1>...",
  "contentLength": 125,
  "fetchedAt": "2026-08-28T12:00:00.000Z"
}

A 200 response means the page was converted successfully. Each successful scrape consumes one credit.

Getting started

Guides

API reference

Prerequisites

Scrape a page

Next steps

Scraping options

API reference

​Prerequisites

​Scrape a page

​Next steps

Scraping options

API reference

Prerequisites

Scrape a page

Next steps