Text

Markdown to HTML

0calls

1 credits / call

Call this endpoint directly to convert Markdown text to styled HTML. It's not only suitable for dynamic injection in programs, but also for direct preview during development.

POST

uapis.cn

/api/v1/text/markdown-to-html

Body

text

string

required

Raw Markdown string, maximum size not exceeding 1MB.

format

string

Response format. Pass json to return JSON-wrapped HTML fragment; pass html to directly return text/html, and response content will automatically include complete webpage structure, suitable for browser preview or direct save as webpage file. Default is json.

sanitize

boolean

Whether to enable security mode, filtering out risky scripts in user input. Default is true.

How to Use and Preview

Default Mode: Returns HTML fragment in JSON: When format is not passed, the endpoint returns JSON. You just need to read data.html from the response and assign it to the frontend container, e.g., element.innerHTML = data.html, Vue's v-html, or React with dangerouslySetInnerHTML.
Preview Mode: Directly returns complete HTML webpage: If you want to open the result directly in a browser, or save the response as an independent .html file, pass format="html". In this mode, the endpoint will directly return complete webpage source code with <!DOCTYPE html><html>....

Overview

Beautiful typography built-in, no need to write CSS manually: The returned results already have built-in styles, titles, quotes, tables, task lists and code blocks can be displayed directly.
Supports rich layout elements: In addition to standard Markdown, this endpoint can also correctly handle common GFM syntax, such as tables, task lists and code blocks with language tags.
Secure handling of user content: Security mode is enabled by default, automatically filtering risky scripts in raw HTML. If the content source is absolutely trusted and you really need to keep the original HTML, you can set sanitize to false.

Request body

Request body uses application/json. text is required; format and sanitize are optional.

text

stringrequired

Raw Markdown string, maximum size not exceeding 1MB.

format

stringoptional

sanitize

booleanoptional

Whether to enable security mode, filtering out risky scripts in user input. Default is true.

Name	Type	Attributes	Description
`text`	string	required	Raw Markdown string, maximum size not exceeding 1MB.
`format`	string	optional	Response format. Pass `json` to return JSON-wrapped HTML fragment; pass `html` to directly return `text/html`, and response content will automatically include complete webpage structure, suitable for browser preview or direct save as webpage file. Default is `json`.
`sanitize`	boolean	optional	Whether to enable security mode, filtering out risky scripts in user input. Default is `true`.

Response

200 / OK

Conversion successful. Whether JSON or plain HTML is returned depends on the format parameter.

Format 1application/json

JSON

{
  "data": {
    // Converted HTML string, content is styled HTML fragment.
    "html": "<style>...</style><div class=\"uapi-markdown\"><h1 id=\"coffee\">Coffee</h1><p>...</p></div>"
  }
}

Format 2text/html

HTML

<!DOCTYPE html><html lang="en-US"><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>Markdown Preview</title></head><body><main><style>...</style><div class="uapi-markdown"><h1 id="coffee">Coffee</h1><p>...</p></div></main></body></html>

400 / Bad Request

Request parameter error. May be request body format error, text is empty, or format value is invalid.

Format 1Request body format error

JSON

{
  "code": "INVALID_PARAMETER",
  "message": "Request body format is incorrect, please pass standard JSON"
}

Format 2Missing Markdown text

JSON

{
  "code": "INVALID_PARAMETER",
  "message": "text cannot be empty"
}

Format 3Response format error

JSON

{
  "code": "INVALID_PARAMETER",
  "message": "format only allows json or html"
}

413 /

Markdown text exceeds current size limit.

JSON

{
  "code": "TEXT_TOO_LARGE",
  "message": "Markdown content cannot exceed 1MB"
}

500 / Internal Server Error

Error occurred during conversion, please try again later.

JSON

{
  "code": "REQUEST_FAILED",
  "message": "Markdown to HTML failed, please try again later"
}

503 / Service Unavailable

Service temporarily unavailable.

JSON

{
  "code": "SERVICE_TEMPORARILY_UNAVAILABLE",
  "message": "Markdown to HTML service is temporarily unavailable, please try again later"
}

Quick start

Pick your language to see usage examples

Auth mode:

cURL command

curl -X POST 'https://uapis.cn/api/v1/text/markdown-to-html' \
  -H 'Content-Type: application/json' \
  -d '{"text": "# Coffee

**Coffee** is a brewed beverage made from the seeds of the coffee plant—the *coffee bean*—which are roasted, ground, and steeped in hot water. It is one of the most widely consumed soft drinks in the world.

> Wild coffee originated in tropical regions of Africa and Asia. Today, roasted green coffee beans are one of the world's largest agricultural exports, grown in over 70 countries.

![Coffee photo](https://images.unsplash.com/photo-1534234757579-8ad69d218ad4?q=80&w=1170&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D)

## Nutritional value (per 100 g)

| Nutrient | Amount | Daily Reference Intake (DRI) |
| :--- | :--- | :--- |
| Energy | 2 kJ (0.48 kcal) | - |
| Caffeine | 40 mg | - |
| Riboflavin (Vitamin B2) | 0.076 mg | 6% |
| Magnesium | 3 mg | 1% |
| Potassium | 49 mg | 1% |

## How coffee is made

From cherry to cup, coffee goes through a strict series of steps:

- [x] **Harvesting**: by machine or by hand.
- [x] **Processing**: removing the fruit layer and drying the beans to a suitable moisture level (washed, sun-dried, or honey processing).
- [ ] **Roasting**: green beans release moisture and expand. Roasts are typically classified as light, medium, or dark.

## Brewing and extraction

All coffee is brewed from ground coffee and hot water. Common methods include:

1. **Drip**: such as pour-over coffee. Water meets the grounds only once.
2. **Pressure**: such as espresso, where 8–9 bars of pressure extract a concentrated shot.
3. **Immersion**: such as cold brew, where ground coffee steeps in cold water in a glass container.

## A related protocol

In computer networking there is even a dedicated protocol for controlling coffee pots (Hyper Text Coffee Pot Control Protocol, HTCPCP):

```http
BREW /pot-1/coffee HTCPCP/1.0
Host: coffee-pot.local
Content-Type: message/coffeepot
Accept-Additions: cream, whole-milk
```"}'

Frequently asked questions

How do I preview after getting a large HTML string?

The easiest way is to set `format` to `html` in the request. This way, the endpoint will directly return `text/html` with complete webpage structure, and you can view it directly in browser, Postman's Preview panel, or save locally as `.html` file.

How should I integrate the default JSON mode response into frontend?

In default mode, please read `data.html` from the response, then insert this string into page container. Since the return value already has built-in styles, usually just assigning to `innerHTML`, Vue's `v-html`, or React's `dangerouslySetInnerHTML` will display it directly.

Why didn't my HTML tags take effect?

To safely display user-submitted content, the endpoint filters out raw HTML tags by default. If you can ensure the content source is absolutely trusted, you can set the `sanitize` parameter to `false` to display them.

Related APIs

Markdown to PDF

When your business system needs to provide "Export as PDF" functionality, there's no need to deploy complex layout engines on the backend. Just send the Markdown text to this endpoint, and you can directly obtain print-quality PDF files.

Format Conversion

Need to convert between different text formats? This endpoint supports mutual conversion between Base64, Hex, URL, HTML, Unicode and other formats, and can also generate MD5, SHA256 and other hash values.

PreviousAES Advanced Decryption

NextMarkdown to PDF