apyhub
▣ DEVELOPER TOOLS · FILE CONVERSION

Convert Markdown to HTML files API

Hosted on ApyHub

What it does

Markdown to HTML converts a Markdown file or a remote Markdown URL into HTML output. Send a .md file in the request body, or pass a url to a hosted Markdown document, and get HTML back as either a downloadable file or a signed link.

Use the file endpoints when you want to upload Markdown directly, or the URL endpoints when the source already lives somewhere else. The download variants return HTML as binary output, while the link variants return a JSON object with a data field containing a URI.

This is useful when you generate documentation, changelogs, README pages, or knowledge-base articles in Markdown and need to publish them as HTML for a web app, CMS, or static site pipeline. You control the output filename on the download endpoint with the output query parameter.

Markdown to HTML is a straightforward conversion layer for teams that want to move between authoring-friendly Markdown and browser-ready HTML without building their own parser or file handling logic.

▣ ENDPOINT 01 / 04
POST
Convert uploaded Markdown file to HTML download
http://localhost:8080/apyhub/convert-markdown-to-html-files/file/download
QUICKSTARTGUIDE

Quickstart

Upload a Markdown file to convert it and optionally name the output HTML file.

curl -X POST "http://localhost:8080/apyhub/convert-markdown-to-html-files/file/download" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/file.md" \
  -F "output=index.html"

What you'll get back

Returns a binary file download (string with format: binary), not a JSON object.

TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
body*
Markdown file (.md) to convert. Mandatory.

About this endpoint

What it does

Converts an uploaded Markdown file to HTML and returns the generated file as a binary download. The request sends the Markdown file in the body, and the response is a binary file stream rather than a JSON object.

Query Parameter(s)

AttributeTypeMandatoryDescription
outputStringNoName of the downloaded output file.

Request Body

ParameterTypeMandatoryDescription
fileStringYesMarkdown file (.md) to convert. Binary upload.

Response

Returns a binary file download. The output schema is a single binary string, so there is no JSON wrapper or named response field to parse.

Query parameters

Name
Type
Description
outputOPTIONAL
string
—

Body

Name
Type
Description
bodyREQUIRED
object
—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 02 / 04
POST
Convert uploaded Markdown file to signed HTML URL
http://localhost:8080/apyhub/convert-markdown-to-html-files/file/link
QUICKSTARTGUIDE

Quickstart

Convert a local Markdown file to HTML by uploading it as multipart form data.

curl -X POST "http://localhost:8080/apyhub/convert-markdown-to-html-files/file/link" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/file.md"

What you'll get back

Returns a JSON object with a data string field containing a URI.

{
  "data": "https://example.com/output.html"
}
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
body*
Markdown file (.md) to convert. Mandatory.

About this endpoint

What it does

Converts an uploaded Markdown file into an HTML file and returns a signed URL to the generated file. The request sends the Markdown file in the body, and the response returns the resulting file URL as a string.

Request Body

ParameterTypeMandatoryDescription
fileStringYesMarkdown file (.md) to convert; binary file upload.

Response

Returns a JSON object with a data string field containing a URI to the generated HTML file.

ParameterTypeMandatoryDescription
dataStringYesSigned URL of the generated HTML file.

Body

Name
Type
Description
bodyREQUIRED
object
—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 03 / 04
POST
Convert remote Markdown URL to HTML download
http://localhost:8080/apyhub/convert-markdown-to-html-files/url/download
QUICKSTARTGUIDE

Quickstart

Download the HTML generated from a Markdown file URL by sending the source url.

curl -X POST "http://localhost:8080/apyhub/convert-markdown-to-html-files/url/download" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://assets.apyhub.com/samples/sample.md"}'

What you'll get back

Returns a binary file response (string with format: binary), which is the downloaded HTML content.

(binary file)
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*

About this endpoint

What it does

Converts a remote Markdown file fetched from a URL into an HTML file for download. You send the Markdown file URL in the request body, and the response returns the generated file as binary content.

Request Body

ParameterTypeMandatoryDescription
urlStringYesThe remote Markdown file URL to convert. Must be a valid URI.

Response

Returns binary content representing the generated HTML file for download. The output schema is a string with binary format, so the response body is a file stream rather than a JSON object.

ParameterTypeMandatoryDescription
(binary response)StringYesThe generated HTML file content.

Body

Name
Type
Description
bodyREQUIRED
object
—
▣ ENDPOINT 04 / 04
POST
Convert remote Markdown URL to signed HTML URL
http://localhost:8080/apyhub/convert-markdown-to-html-files/url/link
QUICKSTARTGUIDE

Quickstart

Convert a Markdown file from a public URL into HTML by sending its link.

curl -X POST "http://localhost:8080/apyhub/convert-markdown-to-html-files/url/link" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://assets.apyhub.com/samples/sample.md"}'

What you'll get back

Returns a JSON object with a data string field containing the URI of the generated HTML file.

{
  "data": "https://..."
}
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*

About this endpoint

What it does

Converts a remote Markdown file, identified by its URL, into a signed HTML file URL. The request takes a Markdown url and returns a JSON object containing the generated HTML data URL.

Request Body

ParameterTypeMandatoryDescription
urlStringYesThe remote Markdown file URL to convert. Must be a valid URI.

Response

Returns a JSON object with a data string field containing the signed HTML file URL.

ParameterTypeMandatoryDescription
dataStringYesThe signed HTML file URL returned by the conversion. Must be a valid URI.

Body

Name
Type
Description
bodyREQUIRED
object
—
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.

Product
CatalogPricingBecome a providerStatus (opens in new tab)
Company
AboutBlogCareers (opens in new tab)Contact
Legal
Terms of ServicePrivacy PolicyProvider terms
© 2026 APYHUB · BUILT FOR DEVELOPERS