▣ DEVELOPER TOOLS · FILE CONVERSION

Convert Markdown to HTML files API

What it does

Markdown to HTML converts a Markdown file or a remote Markdown URL into HTML, either as a direct download or as a signed URL you can fetch later. Send a .md file in the file field, or pass a Markdown url, and get HTML output back in the format you choose.

Use the /file/download and /url/download endpoints when you want the converted HTML returned as a binary file. Use /file/link or /url/link when you want a signed HTML data URL instead. The service keeps the interface narrow: the file-based endpoints require file, and the URL-based endpoints require url.

This is a straightforward fit for pipelines that publish documentation, render user-authored notes, or convert Markdown assets stored in object storage into HTML for web delivery. If your app already stores content as Markdown, you can convert it at the edge without building your own parser and export flow.

▣ ENDPOINT 01 / 04

POST

Convert uploaded Markdown file to HTML download (FC-02)

https://api.eu.apyverse.com/apyhub/convert-md-to-html/file/download

QUICKSTART

GUIDE

Quickstart

Upload a Markdown file to download the converted HTML output.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-md-to-html/file/download" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/file.md"

What you'll get back

Returns a binary file (string with format: binary) containing the converted HTML download.

(binary file)

TRY ITLIVE · 50 ATOMS

API key

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.

About this endpoint

What it does

Uploads a Markdown file and returns the converted HTML as a downloadable binary response.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Name of the generated HTML file to download. Example: `index.html`.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	Markdown file (`.md`) to convert. Binary file upload.

Response

Returns a binary response containing the converted HTML file. The output schema is a single binary payload with no JSON wrapper or named fields.

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 (FC-02)

https://api.eu.apyverse.com/apyhub/convert-md-to-html/file/link

QUICKSTART

GUIDE

Quickstart

Convert a Markdown file from a multipart upload into HTML.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-md-to-html/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 the URI of the generated HTML file.

{
  "data": "https://example.com/output.html"
}

TRY ITLIVE · 50 ATOMS

API key

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.

About this endpoint

What it does

Converts an uploaded Markdown file to a signed HTML URL. The request uploads a .md file, and the response returns a JSON object containing the generated URL in data.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	Markdown file (`.md`) to convert. Mandatory.

Response

Returns a JSON object with a data string field containing a URI for the converted HTML output.

Parameter	Type	Mandatory	Description
data	String	Yes	URI of the signed HTML URL generated from the uploaded Markdown 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 (FC-02)

https://api.eu.apyverse.com/apyhub/convert-md-to-html/url/download

QUICKSTART

GUIDE

Quickstart

Download a Markdown file from a URL and return the converted content.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-md-to-html/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 string containing the generated HTML output.

(binary HTML content)

TRY ITLIVE · 50 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Converts a remote Markdown file, fetched from the URL you provide, into an HTML download response. The request body contains the source url, and the endpoint returns a binary file stream rather than a JSON object.

Request Body

Parameter	Type	Mandatory	Description
url	String	Yes	The remote Markdown file URL to fetch and convert. Must be a valid URI.

Response

Returns a binary response (string with format: binary) containing the converted HTML download. The output schema does not define a JSON wrapper or named fields for this endpoint.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 04 / 04

POST

Convert remote Markdown URL to signed HTML URL (FC-02)

https://api.eu.apyverse.com/apyhub/convert-md-to-html/url/link

QUICKSTART

GUIDE

Quickstart

Convert a Markdown file from a URL into HTML by sending the file URL in the request body.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-md-to-html/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 generated HTML file URL.

{
  "data": "https://..."
}

TRY ITLIVE · 50 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Converts a remote Markdown file URL into a signed HTML URL. Send the Markdown file location in the request body and the response returns the generated HTML URL.

Request Body

Parameter	Type	Mandatory	Description
url	String	Yes	The remote Markdown file URL to convert. Must be a valid URI. Example: `https://assets.apyhub.com/samples/sample.md`

Response

Returns a JSON object with a data string field containing a URI for the signed HTML URL. This is the success response for the endpoint.

Parameter	Type	Mandatory	Description
data	String	Yes	The generated signed HTML URL returned by the conversion.

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.