文档转 Markdown REST API 与 SDK 生成器
为符合 OpenAPI 3.0.3 规范的 POST /api/v1/conversions 生成免密钥 cURL、TypeScript、Python 与 Node.js 客户端代码。
公开 v1 资源:POST /api/v1/conversions(Multipart Form-Data · 最大 10 MB · 免密钥 REST API)
无状态内存级 API — 上传文件在转换完成后立即丢弃
打开 Swagger UI(/swagger)
RESTful v1 资源与响应规范
ToMarkdown 提供三个符合 OpenAPI 3.0.3 的接口资源(/openapi.json):
POST /api/v1/conversions(createConversion)、GET /api/v1/formats(listFormats)与 GET /api/v1/health(getHealth)。
HTTP/1.1 200 OK
Content-Type: application/json
X-RateLimit-Limit: 15
X-RateLimit-Remaining: 14
{
"filename": "architecture-spec.pdf",
"media_type": "application/pdf",
"size_bytes": 248910,
"token_count": 1842,
"markdown": "# Architecture Specification\n\nConverted Markdown content..."
}
- 内容协商:传入
Accept: application/json(?format=json)获取结构化Conversion对象,或传入Accept: text/markdown(?format=markdown)直接获取.md下载流。 - 配额与错误处理:支持 22 种文档/电子表格/标记扩展名,单文件最大 10 MB(每 IP
15 req/min);遇到400、413、415(图片/SVG)与429时返回结构化的{ "error": { "code", "message", "status" } }。
常见问题
调用 POST /api/v1/conversions 需要 API 密钥吗?
不需要。10 MB 以内的公开文档转换(.pdf、.docx、.xlsx、.ods、.numbers、.html、.xml、.csv)完全免费且无需 API 密钥。图片与 SVG 文件会被拒绝(415),并按 IP 限流(15 req/min)以保障服务高可用。
POST /api/v1/conversions 返回怎样的 JSON Schema?
当指定 Accept: application/json 或 ?format=json 时,POST /api/v1/conversions 返回 { filename, media_type, size_bytes, token_count, markdown },其中 markdown 为提取出的 GFM 文本,token_count 为估算的 Token 数量。