API 文档
通过 API 将 Markdown 内容转换为精美图片,轻松集成到您的应用或工作流中。
端点
POST https://markdowntoimage.cn/api/v1/images/generate认证
在请求头中添加 Authorization 字段,使用 Bearer Token 方式认证:
Authorization: Bearer <token>您可以在「个人资料 > API Token」页面创建和管理 Token。
请求参数
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| markdown | string | 是 | — | 要转换的 Markdown 内容 |
| width | number | 否 | 800 | 图片宽度(200-2560) |
| format | string | 否 | png | 图片格式:png / jpeg / webp |
| quality | number | 否 | 2.0 | 缩放倍率(1.0-3.0) |
| theme | string | 否 | light | 背景主题 |
| codeStyle | string | 否 | nord | 代码高亮样式 |
| fontFamily | string | 否 | sans | 字体 |
响应示例
接口统一返回 JSON 格式,imageUrl 为可直接访问的图片下载链接(非 base64)。链接有效期 24 小时,请及时下载保存。
{
"success": true,
"imageUrl": "https://markdowntoimage.cn/api-images/2026-02-23/abc123.png",
"format": "png",
"width": 800,
"expiresAt": "2026-02-24T07:36:00.000Z",
"usage": {
"freeUsed": 1,
"freeLimit": 30,
"creditDeducted": 0
}
}生成的图片链接有效期为 24 小时,过期后将自动删除。请在有效期内下载保存。
使用量统计
每次调用接口时,响应中的 usage 字段会返回当前使用量信息:
| 参数 | 说明 |
|---|---|
| freeUsed | 本月已使用免费次数 |
| freeLimit | 每月免费额度上限(30) |
| creditDeducted | 本次调用扣除的 Credit 数(免费调用为 0,付费调用为 1) |
代码示例
curl -X POST https://markdowntoimage.cn/api/v1/images/generate \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token>" \
-d '{
"markdown": "# Hello World\n\nThis is a test.",
"width": 800,
"format": "png",
"theme": "light",
"codeStyle": "nord"
}'可选主题(theme)
以下主题可用于 theme 参数,带 transparent 后缀的主题生成透明背景图片:
lightdarknordgithubmonokaisolarizeddraculagithub-darkone-darktransparenttransparent-darkoceansunsetforestpurple-dreammidnightpastelmintlavender可选代码样式(codeStyle)
以下样式可用于 codeStyle 参数,控制代码块的语法高亮风格:
浅色
defaultgithubvsxcodeatom-one-lightgooglecodeideaarduino-lighta11y-lightintellij-lightstackoverflow-light深色
nordmonokaimonokai-sublimeatom-one-darkatom-one-dark-reasonablevs2015androidstudiogithub-darkobsidiannight-owltomorrow-nighttomorrow-night-bluetomorrow-night-brighttomorrow-night-eightiessolarized-darkgruvbox-darkzenburnrailscastsir-blackhybridan-old-hopea11y-darkstackoverflow-dark彩色
rainbowsunburstshades-of-purpleparaiso-darkparaiso-lightartaagategradient-lightgradient-dark可选字体(fontFamily)
以下字体可用于 fontFamily 参数:
Google 字体
sansinterserifrobotofirajetbrainssource-codeelegantubuntumodernarticledocs多语言字体
chinesetraditionaljapanesearabiccyrillicanek-latin系统字体
times-new-romanmicrosoft-yaheipingfang-schiragino-sans-gbarialgeorgiaverdana获取使用量统计
查询当前账户的 API 调用量和历史记录。此接口使用登录 Session 认证(非 Bearer Token),适合在前端页面中调用。
端点
GET https://markdowntoimage.cn/api/api-tokens/usage认证方式
需要用户已登录(Cookie Session 认证),无需传递 Authorization header。
响应示例
{
"success": true,
"current": {
"yearMonth": "2026-02",
"count": 5,
"limit": 30,
"remaining": 25
},
"history": [
{ "yearMonth": "2026-02", "count": 5 },
{ "yearMonth": "2026-01", "count": 30 }
]
}current 字段说明
| 参数 | 说明 |
|---|---|
| yearMonth | 当前月份(格式:YYYY-MM) |
| count | 本月已调用次数 |
| limit | 每月免费额度上限(30) |
| remaining | 本月剩余免费次数 |
history 字段说明
返回最近 6 个月的月度调用记录数组,每条记录包含 yearMonth 和 count。
MCP Server(AI 工具集成)
通过 MCP (Model Context Protocol) 在 Claude Desktop、Cursor、VS Code 等 AI 工具中直接使用 Markdown 转图片功能。
安装
npm install -g markdowntoimage-cn-mcp
配置
将以下配置添加到对应工具的配置文件中:
配置文件路径:~/Library/Application Support/Claude/claude_desktop_config.json(macOS)或 %APPDATA%\Claude\claude_desktop_config.json(Windows)
{
"mcpServers": {
"markdowntoimage": {
"command": "npx",
"args": ["-y", "markdowntoimage-cn-mcp"],
"env": {
"MTI_API_TOKEN": "<your_token>"
}
}
}
}环境变量
| 参数 | 必填 | 说明 |
|---|---|---|
| MTI_API_TOKEN | 是 | API Token,在「个人资料 > API Token」页面创建 |
| MTI_API_BASE_URL | 否 | API 地址,默认 https://markdowntoimage.com,自部署时可修改 |
使用限制
- 每月每个账户 30 次免费调用额度,生成的图片将带有水印
- 超出免费额度后需消耗 Credit(与页面转换图片扣费一致),生成的图片不带水印
- 图片宽度范围:200 - 2560 像素
- 缩放倍率范围:1.0 - 3.0