---
title: "通过 REST API 转换 Markdown（旧版）"
description: "了解如何通过旧版 REST API 进行 Tiptap Markdown 文件的转换。"
canonical_url: "https://tiptap.zhcndoc.com/conversion/legacy/markdown/rest-api"
---

# 通过 REST API 转换 Markdown（旧版）

了解如何通过旧版 REST API 进行 Tiptap Markdown 文件的转换。

> **旧版 Markdown REST API（已弃用）:**
>
> 此 REST API 已弃用，并将在 2026 年的某个时间点停止服务，团队会提前通知。对于新的集成，请使用更新后的 [Markdown 导出 REST API](https://tiptap.zhcndoc.com/conversion/export/markdown/rest-api.md) 和 [Markdown 导入 REST API](https://tiptap.zhcndoc.com/conversion/import/markdown/rest-api.md)。

- **1. 激活试用或订阅**

  开始一个[免费试用](https://cloud.tiptap.dev/v2?trial=true)或在您的账户中[订阅入门计划](https://cloud.tiptap.dev/v2/billing)。
- **2. 配置 Convert 应用**

  如果您想集成 REST API，请从[您的仪表板](https://cloud.tiptap.dev/v2/cloud/convert)中获取您的应用 ID 和 Convert 密钥。
- **3. 从私有注册表安装**

  要安装前端扩展，请按照[设置指南](https://tiptap.zhcndoc.com/guides/pro-extensions.md)对 Tiptap 的私有 npm 注册表进行身份验证。

> **使用 Postman:**
>
>  在我们的
>
> Postman 集合
>
> 中实验转换 API。 

## 导入 API 端点

`POST /import`

将 .md 文件（或 gfm）转换为 Tiptap JSON。

```bash
curl -X POST "https://api.tiptap.dev/v1/convert/import?format=md" \
  -H "Authorization: Bearer <your-jwt>" \
  -H "X-App-Id: <your-app-id>" \
  -F "file=@/path/to/file.md"
```

### 导入 API 头部

| 头部              | 描述                                                                                                      |
| --------------- | ------------------------------------------------------------------------------------------------------- |
| `Authorization` | `Bearer <your-jwt-token>`                                                                               |
| `X-App-Id`      | 来自[https://cloud.tiptap.dev/convert-settings](https://cloud.tiptap.dev/convert-settings)的 Convert 应用 ID |

### 导入 API 字段

| 字段                       | 描述                           |
| ------------------------ | ---------------------------- |
| `file`                   | 要转换的 Markdown 文件             |
| `imageUploadCallbackUrl` | 可选端点，用于处理 Markdown 文件引用的本地图像 |

## 导出 API 端点

`POST /export`

将 Tiptap JSON 转换为 .md 或 .gfm。

```bash
curl -X POST "https://api.tiptap.dev/v1/convert/export" \
  -H "Authorization: Bearer <your-jwt>" \
  -H "X-App-Id: <your-app-id>" \
  -F 'prosemirrorJson={"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Hello from Tiptap!"}]}]}' \
  -F 'to=md' \
  --output document.md
```

#### 导出 API 头部

| 头部              | 描述                                                                                                      |
| --------------- | ------------------------------------------------------------------------------------------------------- |
| `Authorization` | `Bearer <your-jwt-token>`                                                                               |
| `X-App-Id`      | 来自[https://cloud.tiptap.dev/convert-settings](https://cloud.tiptap.dev/convert-settings)的 Convert 应用 ID |

#### 导出 API 字段

| 字段                | 描述                                      |
| ----------------- | --------------------------------------- |
| `prosemirrorJson` | Tiptap/ProseMirror JSON                 |
| `to`              | 目标格式，`md` 或 `gfm`，用于 GitHub 风格 Markdown |