apyhub-logo

Convert MD content to HTML content API

50 atoms
Base tier

About

This API lets you transform Markdown text into HTML.
With this API you can quickly and accurately transform raw Markdown to raw HTML, and JSON Markdown to JSON HTML with minimal loss to the formatting and data.
It is often easier to write documentation in markdown format and have it converted into HTML for rendering purposes. In such cases, this API service can help to create an accurate rendering of the markdown contents to HTML. By converting Markdown to HTML, you can ensure that your content is compatible with all web browsers and devices and maintain consistency across multiple pages or sites. While Markdown is great for basic text formatting, converting it to HTML can enhance the functionality and accessibility of your web content.
Try out the Markdown Text to HTML API in the API playground for free, improve your document workflow, and reduce HTML conversion errors with a simple API call.
Select API Endpoints
Input

API Playground

API Documentation

submit raw MD: generated raw HTML
POST
https://api.apyhub.com/convert/md/html/raw

Request example

1
curl --location --request POST 'https://api.apyhub.com/convert/md/html/raw' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: text/plain' \
4
--data-raw '# Heading 1
5
## Heading 2
6
### Heading 3
7
8
**Bold text**
9
10
*Italic text*
11
12
- Unordered list item 1
13
- Unordered list item 2
14
- Nested unordered list item
15
16
1. Ordered list item 1
17
2. Ordered list item 2
18
1. Nested ordered list item'
The method lets you pass a raw markdown in body and returns the converted raw html as an output.
Method: POST
Content Type: text/plain
Request Body
TypeMandatoryDescription
Raw MarkdownYesProvide raw markdown as text/plain.
Sample Response
1
<h1>Heading 1</h1>
2
<h2>Heading 2</h2>
3
<h3>Heading 3</h3>
4
<p><strong>Bold text</strong></p>
5
<p><em>Italic text</em></p>
6
<ul>
7
<li>Unordered list item 1</li>
8
<li>Unordered list item 2
9
<ul>
10
<li>Nested unordered list item</li>
11
</ul>
12
</li>
13
</ul>
14
<ol>
15
<li>Ordered list item 1</li>
16
<li>Ordered list item 2
17
<ol>
18
<li>Nested ordered list item</li>
19
</ol>
20
</li>
21
</ol>

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
400Request is invalid or url is not accessible.
401Required authentication information is either missing or not valid for the resource.
500There was an error in processing this request

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.