开发者 API
用一个 API 将各种文件转换为 Markdown
在脚本、自动化流程和产品中自动完成文档转换。上传支持的文件，即可通过一次请求获得整洁的 Markdown 或纯文本。
身份认证
在控制台创建 API 密钥，然后通过 Bearer Token 或 X-API-Key 请求头发送。请只在服务端保存密钥，不要暴露在浏览器代码中。
curl -X POST https://www.word2md.net/api/v1/convert \
-H "Authorization: Bearer sk-your-key" \
-F "file=@./report.pdf" \
-F "output_format=markdown"接口
POST /api/v1/convert转换文件
使用 multipart 表单提交 file 字段（最大 50 MB），并可将 output_format 设置为 markdown 或 text。
GET /api/v1/convert转换能力
GET 此接口可查看支持的扩展名、文件大小限制和当前额度规则。
GET /api/v1/usage用量与额度
GET 此接口可查看今日 API 用量、套餐、剩余额度和下次 UTC 重置时间。
支持的文件类型
支持常见办公文档、PDF、表格、演示文稿、结构化数据、媒体、压缩包和图片。
.docx.doc.pdf.pptx.ppt.xlsx.xls.csv.tsv.html.htm.xml.json.txt.md.jpg.jpeg.png.gif.webp.bmp.tif.tiff.mp3.wav.mp4.mov.avi.zip额度与计费
每个账户每天都有 API 免费额度。用完套餐额度后，每次成功转换会从订阅余额或一次性加油包中扣除 1 积分。
| 套餐 | 每日 API 额度 | 超额调用 |
|---|---|---|
| 免费版 | 50 / day | 加油包积分 |
| Pro | 500 / day | 加油包积分 |
| Pro+ | 1,500 / day | 加油包积分 |
| Ultimate | 已包含 | 已包含 |
返回格式
成功转换会返回转换内容、原始文件名、输出格式、扣除积分以及更新后的用量。
{
"success": true,
"object": "conversion",
"content": "# Report\n\n...",
"format": "markdown",
"filename": "report.pdf",
"credits_charged": 0,
"usage": { "tier": "free", "used": 1, "daily": 50, "remaining": 49 }
}错误与状态码
错误会以 JSON 返回，并包含稳定的错误码和可读的错误信息。
401 | 缺少或无效的 API 密钥 |
400 | 缺少文件、扩展名不支持或文件过大 |
402 | 每日额度和可用积分均已用尽 |
500 | 转换服务失败；已扣除的积分会自动退回 |
生产环境建议
- 使用 HTTPS，并将密钥保存到环境变量
- 上传前校验文件大小
- 对临时 5xx 错误使用指数退避重试
- 读取 usage 对象跟踪剩余额度
- 处理完成后删除敏感文件
API 常见问题
可以转换哪些文件？
支持 Word、PDF、PowerPoint、Excel、CSV、HTML、XML、JSON、文本、Markdown、图片、音频、视频和 ZIP 文件，具体取决于可用的转换器。
免费额度如何计算？
免费账户每天有 50 次 API 转换额度；Pro 每天 500 次，Pro+ 每天 1,500 次，Ultimate 不限次数。
每日额度用完后会怎样？
超额成功转换每次消耗订阅余额或加油包中的 1 积分；没有剩余积分时会返回 HTTP 402。
如何保护 API 密钥？
请像保护密码一样保护密钥：仅在服务端使用 HTTPS 保存，必要时定期轮换，泄露后立即撤销。