URL to Markdown

Overview

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.

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/blog/getting-started",
  "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/blog/getting-started",
  "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/blog/getting-started",
    "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/blog/getting-started",
  "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.

Parameters

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

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/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.

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.

Use cases

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

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: