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 ``, 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.
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
}'const res = await fetch('https://api.apiverve.com/v1/urltomarkdown', {
method: 'POST',
headers: {
'x-api-key': 'your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"url": "https://example.com/",
"includeImages": true,
"includeLinks": true
}),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.post(
"https://api.apiverve.com/v1/urltomarkdown",
headers={"x-api-key": "your_api_key_here"},
json={
"url": "https://example.com/",
"includeImages": True,
"includeLinks": True
},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"url": "https://example.com/",
"includeImages": true,
"includeLinks": true
}`)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/urltomarkdown", body)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}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.
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.
| Parameter | Type | Description |
|---|---|---|
urlRequired | string | The URL of the webpage to convert to Markdown url |
includeImagesOptionalPremium | boolean | Whether to include image references in the Markdown output |
includeLinksOptionalPremium | boolean | Whether 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.
{
"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.
| Field | Type | Example | Description |
|---|---|---|---|
url | string | "https://example.com/" | The original URL that was converted |
title | string | "Example Domain" | Page title extracted from the webpage |
markdown | string | "# Example Domain
This domain is for use in documentation examples without needing permission. Avoi…" | The converted Markdown content |
wordCount | number | 20 | Number of words in the extracted content |
imageCount | number | 0 | Number of images found in the content |
linkCount | number | 1 | Number 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.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read 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.
Related
More in Data Conversion: