Text

Markdown to PDF

0calls

2 credits / call

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.

POST

uapis.cn

/api/v1/text/markdown-to-pdf

Body

text

string

required

Raw Markdown string, maximum size not exceeding 1MB.

theme

string

PDF layout theme. Options: github, minimal, light, dark, default is github.

paper_size

string

PDF paper size. Options: A4 or Letter, default is A4.

Overview

Server-side direct generation: The endpoint directly returns PDF file binary stream, frontend can trigger download without any processing, and backend can easily save for archiving.
Multiple beautiful themes and paper sizes: Built-in professional layout themes like GitHub, dark mode, etc., and supports standard papers like A4, Letter. With simple configuration, you can generate professional documents that match business scenarios.
Public network images can be directly included in PDF: In addition to plain text and standard Markdown syntax, this endpoint can also handle data URI images, or publicly accessible http, https image links. The server will first fetch images through proxy and inline them into the document before rendering, with timeout control.

Request body

Request body uses application/json. text is required, theme and paper_size are optional.

text

stringrequired

Raw Markdown string, maximum size not exceeding 1MB.

theme

stringoptional

PDF layout theme. Options: github, minimal, light, dark, default is github.

paper_size

stringoptional

PDF paper size. Options: A4 or Letter, default is A4.

Name	Type	Attributes	Description
`text`	string	required	Raw Markdown string, maximum size not exceeding 1MB.
`theme`	string	optional	PDF layout theme. Options: `github`, `minimal`, `light`, `dark`, default is `github`.
`paper_size`	string	optional	PDF paper size. Options: `A4` or `Letter`, default is `A4`.

Response

200 / OK

Conversion successful. Response body is PDF binary file stream.

application/pdf

400 / Bad Request

Request parameters are invalid, or Markdown content contains currently disallowed content.

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 3Theme parameter error

JSON

{
  "code": "INVALID_PARAMETER",
  "message": "theme only allows light, dark, minimal, github"
}

Format 4Paper size parameter error

JSON

{
  "code": "INVALID_PARAMETER",
  "message": "paper_size only allows A4 or Letter"
}

Format 5Contains raw HTML

JSON

{
  "code": "UNSUPPORTED_MARKDOWN",
  "message": "Raw HTML tags are currently not supported, please use standard Markdown syntax instead"
}

Format 6Image address not supported

JSON

{
  "code": "UNSUPPORTED_MARKDOWN",
  "message": "Markdown images only allow data URI or publicly accessible http, https addresses, local file paths are not supported"
}

Format 7Contains unsafe link protocol

JSON

{
  "code": "UNSUPPORTED_MARKDOWN",
  "message": "Link protocols only support http, https or mailto"
}

413 /

Markdown text, or image resources referenced in Markdown exceed current size limit.

Format 1Markdown text too large

JSON

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

Format 2Image resource too large

JSON

{
  "code": "FILE_TOO_LARGE",
  "message": "Image in Markdown is too large, please try with a smaller image"
}

500 / Internal Server Error

PDF generation failed, please try again later.

JSON

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

502 / Bad Gateway

Image referenced in Markdown failed to download, or remote returned unrecognizable image content.

JSON

{
  "code": "REQUEST_FAILED",
  "message": "Image in Markdown failed to download, please confirm the image address is accessible"
}

503 / Service Unavailable

PDF rendering service is temporarily unavailable.

Format 1Service not ready

JSON

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

Format 2Renderer temporarily unavailable

JSON

{
  "code": "SERVICE_TEMPORARILY_UNAVAILABLE",
  "message": "PDF rendering service is temporarily unavailable, please try again later"
}

504 / Gateway Timeout

Image referenced in Markdown download timed out.

JSON

{
  "code": "UPSTREAM_TIMEOUT",
  "message": "Image in Markdown download timed out, 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-pdf' \
  -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

Can external images in Markdown be directly exported to PDF now?

Yes. This endpoint will first fetch publicly accessible `http`, `https` images through proxy, and inline the images into the document before rendering PDF. To ensure service stability, image fetching has timeout control; if the source site is too slow, inaccessible, or returns non-normal images, it will report an error directly.

After successful call, how can frontend let users download this PDF?

On success, the response body is the PDF file stream. You can use `fetch` in frontend to receive the response, then convert it to a Blob object via `response.blob()`, and finally generate a temporary download link using `URL.createObjectURL`.

Related APIs

Markdown to HTML

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.

PreviousMarkdown to HTML

NextFormat Conversion