URL to Markdown API

Overview

To use URL to Markdown, you need an API key. You can get one by creating a free account and visiting your dashboard.

POST Endpoint

https://api.apiverve.com/v1/urltomarkdown

Example

How to call the URL to Markdown API in different programming languages.

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 response = 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
})
});

const data = await response.json();
console.log(data);

import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

payload = {
    "url": "https://example.com/blog/getting-started",
    "includeImages": true,
    "includeLinks": true
}

response = requests.post('https://api.apiverve.com/v1/urltomarkdown', headers=headers, json=payload)

data = response.json()
print(data)

package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    payload := map[string]interface{}{
        "url": "https://example.com/blog/getting-started",
        "includeImages": "true",
        "includeLinks": "true"
    }

    jsonPayload, _ := json.Marshal(payload)
    req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/urltomarkdown", bytes.NewBuffer(jsonPayload))

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

{
  "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
  }
}

Authentication

The URL to Markdown API requires authentication via API key. Include your API key in the request header:

X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the URL to Markdown API directly in your browser with live requests and responses.

Parameters

The following parameters are available for the URL to Markdown API:

Response

The URL to Markdown API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <url>https://example.com/blog/getting-started</url>
    <title>Getting Started Guide</title>
    <markdown># Getting Started Guide

Welcome to our platform. This guide will help you get up and running quickly.

## Prerequisites

Before you begin, make sure you have:

- A registered account
- API credentials
- Node.js 18 or higher

## Installation

Install the package using npm:

```
npm install example-sdk
```

## Quick Start

Here&apos;s a simple example to get you started:

1. Import the SDK
2. Initialize with your API key
3. Make your first request

## Next Steps

Check out our [documentation](https://example.com/docs) for more details.

![Example Screenshot](https://example.com/images/screenshot.png)</markdown>
    <wordCount>87</wordCount>
    <imageCount>1</imageCount>
    <linkCount>1</linkCount>
  </data>
</response>

status: ok
error: null
data:
  url: https://example.com/blog/getting-started
  title: Getting Started Guide
  markdown: >-
    # Getting Started Guide


    Welcome to our platform. This guide will help you get up and running
    quickly.


    ## Prerequisites


    Before you begin, make sure you have:


    - A registered account

    - API credentials

    - Node.js 18 or higher


    ## Installation


    Install the package using npm:


    ```

    npm install example-sdk

    ```


    ## Quick Start


    Here's a simple example to get you started:


    1. Import the SDK

    2. Initialize with your API key

    3. Make your first request


    ## Next Steps


    Check out our [documentation](https://example.com/docs) for more details.


    ![Example Screenshot](https://example.com/images/screenshot.png)
  wordCount: 87
  imageCount: 1
  linkCount: 1

Response Structure

All API responses follow a consistent structure with the following fields:

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

GraphQL AccessALPHA

Access URL to Markdown through GraphQL to combine it with other API calls in a single request. Query only the url to markdown data you need with precise field selection, and orchestrate complex data fetching workflows.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

POST https://api.apiverve.com/v1/graphql

query {
  urltomarkdown(
    input: {
      url: "https://example.com/blog/getting-started"
      includeImages: true
      includeLinks: true
    }
  ) {
    url
    title
    markdown
    wordCount
    imageCount
    linkCount
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The URL to Markdown API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

URL to Markdown requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The URL to Markdown API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for URL to Markdown

Official URL to Markdown packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

JitPack

No-Code Integrations

URL to Markdown works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Zapier

Make

Pipedream

n8n

Power Automate

Frequently Asked Questions

People who used this also used...

Based on your interest in URL to Markdown, you might also like these APIs:

XML to JSON

XML to JSON is a simple tool for converting XML to JSON. It returns the JSON representation of the XML provided.

1 credit per call

Words to Numbers

Words to Numbers is a simple tool for converting words to numbers. It returns the words in numbers.

1 credit per call

Website to Text

Website to Text is a simple tool for converting a website to text. It returns the text extracted from the website.

10 credits per call