API REFERENCE / CONVERT
Markdown 转公众号 HTML
调用转换接口前准备有效 API Key。接口返回排版 HTML,不执行公众号草稿创建操作。
POST
/api/convert认证
微信公众号排版 API 接收 Markdown 并返回微信兼容 HTML。服务端请求需提供有效的 md2wechat API Key。
请求头
Md2wechat-API-Key: YOUR_API_KEY请求参数
| 参数 | 类型 | 说明 |
|---|---|---|
markdown | string · 必填 | 要转换的 Markdown 正文。 |
theme | string · 可选 | 主题 ID,默认 default。支持原生、精选与模板主题。 |
fontSize | string · 可选 | small / medium / large,默认 medium。 |
backgroundType | string · 可选 | default / grid / none,默认 default。 |
请求示例
cURL
curl -X POST "https://www.md2wechat.cn/api/convert" \
-H "Content-Type: application/json" \
-H "Md2wechat-API-Key: YOUR_API_KEY" \
-d '{
"markdown": "# 一份值得读完的文章\n\n从清楚的结构开始。",
"theme": "default",
"fontSize": "medium"
}'成功响应
JSON · 结构示例
{
"code": 0,
"msg": "success",
"data": {
"html": "<section>…</section>",
"theme": "default",
"fontSize": "medium",
"backgroundType": "default",
"wordCount": 123,
"estimatedReadTime": 1
}
}常见错误
| 状态 | 含义 | 下一步 |
|---|---|---|
| 400 | 参数错误 | 检查正文与字段值。 |
| 401 | 认证失败 | 检查密钥是否有效、是否过期。 |
| 429 | 请求受限 | 降低请求频率,稍后重试。 |
接口常见问题
公众号排版 API(md2wechat Convert API)是什么?
本页记录中文站的稳定 Convert API:POST /api/convert,用于把 Markdown 转成微信公众号可粘贴的 HTML。标题建议、图片计划、多账号和固定出口等能力由 md2wechat CLI 与公众号排版 Skill 工作流承接。
排版 API 会直接发布公众号吗?
不会。中文站 Convert API 只返回微信公众号可粘贴 HTML,不创建公众号草稿;发布需求应先查看公众号发布 API 页面,并在配置微信凭证后显式授权草稿副作用。
国际站的 /api/v1 服务是否仍然有效?
https://md2wechat.com/api/v1 是国际英文站的有效 Publishing API,用于程序化调用发布服务,与中文站 Convert API 是两个独立服务面。
md2wechat.com、md2wechat.cn 和 md2wechat.app 分别负责什么?
www.md2wechat.cn:在线编辑器、中文文档与稳定 API;md2wechat.app:中文主站的备用访问入口;md2wechat.com:英文介绍与 Publishing API 入口。
哪些 Agent 或工具可以接入 md2wechat Convert API?
Agent 可通过主 CLI、Agent Skill 或直接 HTTP 接口发现并调用当前能力。安装或分发路径不等于宿主兼容验证;CLI 能力请通过 version、capabilities 和 layout discovery 的 JSON 输出确认。
调用 /api/convert 需要哪些认证信息?
只需要提供 md2wechat API Key。转换请求不需要微信 AppID、AppSecret 或公众号白名单。