apyhub-logo

Convert MD file to HTML file

50 atoms
Base tier

About

This Utility API lets you upload and convert a Markdown file to HTML.
With this API, you can transform any Markdown file to an html file with minimal loss to the formatting and data in the spreadsheet.
It is often easier to write documentation in markdown format and have it converted into html for rendering purposes and in such cases this 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.
Endpoint Selector
Input
Output

API Playground

Documentation

upload file: download file
POST
https://api.apyhub.com/convert/md-file/html-file

Request example

1
curl --location --request POST 'https://api.apyhub.com/convert/md-file/html-file?output=test-sample' \
2
--header 'apy-token: {{token}}' \
3
--form 'file=@"test.md"'
The method lets you pass a Markdown file and returns the converted html file as a parameter. This is the most straight forward way to use this service - submit a markdown file and receive the generated HTML file as a response.
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe HTML file name for the converted document. If no output attribute is provided, the default file name will be output.html
Request Body
AttributeTypeMandatoryDescription
fileFileYesThe source markdown file.

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
400Request is invalid or file 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 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 workspace settings (on the left side of the navbar) and go to applications.
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.