Docs/APIs/URL to Markdown

URL to Markdown

Convert webpage to Markdown

OperationalCredits 10 per callp50 2055msData ConversionStar

Overview

The API fetches the page through a scraping service that tries a plain HTTP request first and falls back to a headless browser, retrying through a proxy when the site answers with a blocking status. The browser waits only for the DOM to load and skips images, fonts and media to stay fast. Non-public addresses are refused before any fetch, and pages that block the request or return an error status are reported as failures instead of being converted.

The HTML is parsed and `script`, `style`, `iframe`, `nav`, `header`, `footer`, `aside` and common sidebar, menu, advert, cookie-banner and popup classes are removed. Conversion starts from the first `main`, `article` or common content container, or from `body` if none is present. Headings become `#` to `######`, `pre` blocks become fenced code, tables become pipe tables with the first row as header, and lists, quotes, bold and italic map to their Markdown forms. Runs of blank lines and spaces are collapsed. `title` comes from the page `<title>`, then `og:title`, then the first `h1`.

`includeLinks` writes `[text](url)` and `includeImages` writes `![alt](src)`, resolving relative URLs against the page address and reading lazy-load `data-src` attributes. Both default to false and are ignored on the Free plan. `imageCount` and `linkCount` count elements in the content area whatever those settings are, excluding `#` and `javascript:` links. `wordCount` splits the final Markdown on whitespace. Results are cached for one hour per URL and option combination, and a page that yields under 10 characters of Markdown returns an error.

Live Test URL to Markdown API →

Endpoint

One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.

POSThttps://api.apiverve.com/v1/urltomarkdown
curl -X POST https://api.apiverve.com/v1/urltomarkdown \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/",
  "includeImages": true,
  "includeLinks": true
}'

Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.

Authentication

Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.

401 is the only auth verdict

A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.

Parameters

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.

ParameterTypeDescription
urlRequiredstringThe URL of the webpage to convert to Markdown
url
includeImagesOptionalPremiumbooleanWhether to include image references in the Markdown output
includeLinksOptionalPremiumbooleanWhether to include hyperlinks in the Markdown output

Response

Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.

Sample response
{
  "status": "ok",
  "error": null,
  "data": {
    "url": "https://example.com/",
    "title": "Example Domain",
    "markdown": "# Example Domain\n\n\nThis domain is for use in documentation examples without needing permission. Avoid use in operations.\n\n\n[Learn more](https://iana.org/domains/example)",
    "wordCount": 20,
    "imageCount": 0,
    "linkCount": 1
  }
}

Response fields

Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.

FieldTypeExampleDescription
urlstring"https://example.com/"The original URL that was converted
titlestring"Example Domain"Page title extracted from the webpage
markdownstring"# Example Domain This domain is for use in documentation examples without needing permission. Avoi…"The converted Markdown content
wordCountnumber20Number of words in the extracted content
imageCountnumber0Number of images found in the content
linkCountnumber1Number of links found in the content

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.

StatusMeaningWhat to do
400Input was rejectedRead error; it names the parameter.
401Key missing or invalidCheck the header name and the key value.
403Key valid, but not permittedA key restriction or IP allow-list; see key scoping.
429Rate limited, or out of creditsRead error to tell them apart; see rate limits.

Use cases

Static Site Migration
Developers moving legacy blogs to static site generators extract page titles and converted text to generate clean Markdown source files automatically.
Offline Documentation Readers
Technical writers turn public product docs into offline Markdown manuals, tracking extracted word counts across pages to structure revision bundles.
Knowledge Base Ingestion
Feed live help center URLs to internal knowledge bases, stripping unnecessary HTML markup while preserving document headings and lists for local search.
Web Page Archiving
Before third-party guides go offline, research teams store target articles as version-controlled Markdown text plus recorded image and link counts.

Other ways to use URL to Markdown

Set up URL to Markdown on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.

Give it to an AI agentConnect over MCP and your agent calls it as a native tool — Claude, Cursor, ChatGPT.VerveKit →Reference →

More in Data Conversion:

Was this page helpful?