URL to Markdown API POST

URL to Markdown is a powerful tool for converting any webpage into clean, readable Markdown format. It preserves the document structure including headings, links, lists, and images.

Try it — live request, no key required

Request

POSTapi.apiverve.com/v1/urltomarkdown

Verification

Format

No key required to try it. Get a key to use it in your app.

200 OK

{
  "status": "ok",
  "error": null,
  "data": {
    // URL to Markdown response payload
  }
}

About the URL to Markdown API

URL to Markdown works by fetching the webpage content and parsing the HTML structure. It intelligently converts HTML elements to their Markdown equivalents while preserving formatting. Images are not loaded during fetch for performance, but image links are reconstructed in the output Markdown.

What people use it for

Content Migration: Use the URL to Markdown API to migrate web content to Markdown-based systems like static site generators, documentation platforms, or content management systems
Documentation: Convert web documentation to Markdown for offline reading, archiving, or integration with documentation tools like GitBook, MkDocs, or Docusaurus
Content Archiving: Archive web content in a portable, readable format that can be version controlled and easily searched

Ways to call it

One endpoint, many ways in — REST with JSON, XML, YAML and CSV, plus GraphQL and an MCP interface for AI agents.

JSON: Default REST response
XML: Markup format
YAML: Human-readable
CSV: Tabular export
GraphQL: Query language
MCP: For AI agents

View all integrations →

Other ways to use URL to Markdown

Same data, same APIVerve account, same credit balance — one key works on all of them.

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

Questions.

Common questions about the URL to Markdown API.

Read the docs →

What does the URL to Markdown API do?

URL to Markdown is a powerful tool for converting any webpage into clean, readable Markdown format. It preserves the document structure including headings, links, lists, and images.

How do I authenticate URL to Markdown API requests?

Pass your API key in the x-api-key header over HTTPS. One key works across all 300+ APIVerve APIs — there are no per-endpoint credentials.

How much does the URL to Markdown API cost?

Each call spends 10 credits from your shared pool. The free tier includes 200 credits every month, and paid plans add more headroom.

How fast is the URL to Markdown API?

Response time depends on the endpoint — the p50 through p99 latency for this API is published on this page. Requests are served over HTTPS through a global edge network.

What response formats does the URL to Markdown API support?

JSON by default, plus XML and YAML via the format parameter. GraphQL and an MCP interface for AI agents are available across the catalog.

What HTTP method does the URL to Markdown API use?

POST over HTTPS, following standard REST conventions with a consistent { status, error, data } response envelope.

Request parameters — POST /v1/urltomarkdown

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them. Anything not listed here is dropped rather than passed through.

Required

Parameter	Type	Example	Description
`url`Required	string	`https://www.example.com/article`	The URL of the webpage to convert to Markdown url

Optional

Parameter	Type	Example	Description
`includeImages`OptionalPremium	boolean	`true`	Whether to include image references in the Markdown output default false
`includeLinks`OptionalPremium	boolean	`true`	Whether to include hyperlinks in the Markdown output default false

Example request

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

Authentication

Send your key in the x-api-key header. That is the only auth step — no token exchange, and no per-endpoint scope to configure.

Header	When	Value
`x-api-key`Required	Every request	Your API key. Header names are case-insensitive, so `X-API-Key` is the same header.
`Authorization`Alternate	Instead of the above	`Bearer <key>` — for clients that only expose bearer auth. Resolves to the same account and the same billing.
`content-type`Required	POST body	`application/json`

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.

Response — POST /v1/urltomarkdown

Every APIVerve endpoint returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape.

Sample response

{
  "status": "ok",
  "error": null,
  "data": {
    "url": "https://example.com/blog/getting-started",
    "title": "Getting Started Guide",
    "markdown": "# Getting Started Guide\n\nWelcome to our platform. This guide will help you get up and running quickly.\n\n## Prerequisites\n\nBefore you begin, make sure you have:\n\n- A registered account\n- API credentials\n- Node.js 18 or higher\n\n## Installation\n\nInstall the package using npm:\n\n```\nnpm install example-sdk\n```\n\n## Quick Start\n\nHere's a simple example to get you started:\n\n1. Import the SDK\n2. Initialize with your API key\n3. Make your first request\n\n## Next Steps\n\nCheck out our [documentation](https://example.com/docs) for more details.\n\n![Example Screenshot](https://example.com/images/screenshot.png)",
    "wordCount": 87,
    "imageCount": 1,
    "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/blog/getting-started"`	The original URL that was converted
`title`	string	`"Getting Started Guide"`	Page title extracted from the webpage
`markdown`	string	`"# Getting Started Guide Welcome to our platform. This guide will help you get up and running quickly. ## Prerequisites Before you begin,…`	The converted Markdown content
`wordCount`	number	`87`	Number of words in the extracted content
`imageCount`	number	`1`	Number of images found in the content
`linkCount`	number	`1`	Number of links found in the content

Response headers

Every response carries your balance, so your own code always knows where it stands without polling anything. All four are exposed to browsers through CORS.

Header	What it carries
`x-api-remaining-credits`	Credits left in the current cycle
`x-api-credits-used`	Credits spent in the current cycle
`x-api-max-credits`	The allowance for the cycle
`x-api-version`	Version of the endpoint that answered

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change.

Status	Meaning	What to do
`400`	Input was rejected	Read `error`; it names the parameter that has to change.
`401`	Key missing or invalid	Check the header name and the key value.
`403`	Key valid, but not permitted here	A key restriction or an IP allow-list — never a bad key.
`429`	Rate limited, or out of credits	Read `error` to tell them apart, then back off or top up.

What a call costs — 10 credits per call

Credits are shared across every APIVerve API — one balance, one key, one bill. Failed requests never count against it, so a rejected input costs nothing.

Plan	Per month	Credits	URL to Markdown calls	Per 1,000 calls
Free	Free	200	20	Free
Starter	$29.99	200,000	20,000	$1.50
Pro	$99.99	1,000,000	100,000	$1.00
Mega	$299.99	4,000,000	400,000	$0.75

Calls are what the credits buy at this API's rate — spend them here, on any of the other APIs, or across both. Nothing is reserved per endpoint.

Compare all pricing tiers →

Call it from cURL — POST /v1/urltomarkdown

No SDK to install — this is a plain HTTPS call to /v1/urltomarkdown with your key in the x-api-key header. Swap in a real key and it runs as-is.

cURL

1
2

curl "https://api.apiverve.com/v1/urltomarkdown" \
  -H "x-api-key: YOUR_API_KEY"

Resources

GitHubapiverve/urltomarkdown-apiSource, issues and the examples this page is built from.ReferenceURL to Markdown API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/urltomarkdownnpm APIVerve.API.URLtoMarkdownNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Node.js — POST /v1/urltomarkdown

Install the Node.js SDK, then call the URL to Markdown API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.

Install — npm

npm install @apiverve/urltomarkdown

Node.js

const res = await fetch("https://api.apiverve.com/v1/urltomarkdown", {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const { data } = await res.json();
console.log(data);

Resources

npm@apiverve/urltomarkdownThe published Node.js client, versioned and signed.GitHubapiverve/urltomarkdown-apiSource, issues and the examples this page is built from.ReferenceURL to Markdown API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

APIVerve.API.URLtoMarkdownNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Python — POST /v1/urltomarkdown

No SDK to install — this is a plain HTTPS call to /v1/urltomarkdown with your key in the x-api-key header. Swap in a real key and it runs as-is.

Python

import requests

res = requests.get(
    "https://api.apiverve.com/v1/urltomarkdown",
    headers={"x-api-key": "YOUR_API_KEY"},
)
print(res.json()["data"])

Resources

Also published for

@apiverve/urltomarkdownnpm APIVerve.API.URLtoMarkdownNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from C# / .NET — POST /v1/urltomarkdown

Install the C# / .NET SDK, then call the URL to Markdown API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.

Install — NuGet

dotnet add package APIVerve.API.URLtoMarkdown

C# / .NET

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");

var json = await client.GetStringAsync("https://api.apiverve.com/v1/urltomarkdown");
Console.WriteLine(json);

Resources

NuGetAPIVerve.API.URLtoMarkdownThe published C# / .NET client, versioned and signed.GitHubapiverve/urltomarkdown-apiSource, issues and the examples this page is built from.ReferenceURL to Markdown API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/urltomarkdownnpm

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Go — POST /v1/urltomarkdown

No SDK to install — this is a plain HTTPS call to /v1/urltomarkdown with your key in the x-api-key header. Swap in a real key and it runs as-is.

req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/urltomarkdown", nil)
req.Header.Set("x-api-key", "YOUR_API_KEY")

res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))

Resources

Also published for

@apiverve/urltomarkdownnpm APIVerve.API.URLtoMarkdownNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from PHP — POST /v1/urltomarkdown

No SDK to install — this is a plain HTTPS call to /v1/urltomarkdown with your key in the x-api-key header. Swap in a real key and it runs as-is.

PHP

$ch = curl_init("https://api.apiverve.com/v1/urltomarkdown");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-api-key: YOUR_API_KEY"]);

$response = curl_exec($ch);
echo $response;

Resources

Also published for

@apiverve/urltomarkdownnpm APIVerve.API.URLtoMarkdownNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Ruby — POST /v1/urltomarkdown

No SDK to install — this is a plain HTTPS call to /v1/urltomarkdown with your key in the x-api-key header. Swap in a real key and it runs as-is.

Ruby

require "net/http"

uri = URI("https://api.apiverve.com/v1/urltomarkdown")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

Resources

Also published for

@apiverve/urltomarkdownnpm APIVerve.API.URLtoMarkdownNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Data Conversion

View all 33 →

All articles →

Extract Clean Content from Any WebpageTurn messy web pages into clean Markdown. Perfect for content migration, archiving, AI training data, and building read-later tools.Read

Generate PDFs from HTML with an APIConvert HTML to PDF programmatically. Tutorial covering invoices, reports, receipts, and certificates with code examples.Read

Automating Visual Testing With ScreenshotsCatch visual bugs before users do. Here's how to add screenshot-based testing to your workflow.Read

URL to Markdown API POST

Try it — live request, no key required

About the URL to Markdown API

What people use it for

Ways to call it

Other ways to use URL to Markdown

Questions.

Request parameters — POST /v1/urltomarkdown

Required

Optional

Authentication

Response — POST /v1/urltomarkdown

Response fields

Response headers

Errors

What a call costs — 10 credits per call

Call it from cURL — POST /v1/urltomarkdown

Resources

Also published for

Call it from Node.js — POST /v1/urltomarkdown

Resources

Also published for

Call it from Python — POST /v1/urltomarkdown

Resources

Also published for

Call it from C# / .NET — POST /v1/urltomarkdown

Resources

Also published for

Call it from Go — POST /v1/urltomarkdown

Resources

Also published for

Call it from PHP — POST /v1/urltomarkdown

Resources

Also published for

Call it from Ruby — POST /v1/urltomarkdown

Resources

Also published for

Zero-code embed — one snippet, no backend

Changelog — URL to Markdown API

Data Conversion

Related articles

Ready to build with URL to Markdown? Start with 200 free credits — one key unlocks all 300+ APIs.

Explore the catalog