欢迎使用我们的 Markdown 转图片 API!本教程将引导您完成 API 的接入和使用。

认证方式

API 使用 x-api-key 请求头进行认证。

x-api-key: your_api_key

您可以登录后,在 头像 -> 设置 -> 账户信息 中找到您的 API Key。

API

接口地址

生成图片API

https://api.any2card.com/api/generate-image 该接口用于根据 Markdown 内容和模板设置生成图片。

请求方法:

POST

请求头:

KeyValue
Content-Typeapplication/json
x-api-keyyour_api_key

模式说明

API 支持多种图片生成模式,通过 settings.templateType 参数进行区分。不同的模式需要的参数有所不同。

文本模式

(templateType: "text")

请求参数:

参数名类型必填默认值描述
markdownContentStringMarkdown 文本内容
settingsObject模板设置对象
settings.templateTypeString"imageText"模板类型,固定为 "text"
settings.selectedThemeString选中的主题 (例如: "default", "github", "custom")
settings.cardWidthInteger440卡片宽度 (px),例如 750
settings.cardHeightInteger586卡片高度 (px),例如 1000
settings.deviceScaleFactorInteger2像素比(清晰度),例如 1,2,3
settings.fontFamilyString"var(--font-noto-serif-sc)"字体系列,例如 "Arial, sans-serif"
settings.borderRadiusInteger15边框圆角 (px),例如 10
settings.verticalPaddingInteger30垂直内边距 (px),例如 20
settings.horizontalPaddingInteger30水平内边距 (px),例如 20
settings.isDarkModeBooleanfalse是否暗黑模式,例如 false
settings.isContentCenterBooleanfalse是否内容居中,例如 false
settings.backgroundColorString背景颜色 (HEX, RGB, 或颜色名),例如 "#ffffff"
settings.cardColorString卡片颜色 (HEX, RGB, 或颜色名),例如 "#f0f0f0"
settings.opacityInteger透明度 (0-100),例如 100
settings.splitModeString"long"分割模式 (例如: "auto", "manual")
settings.heightOverflowHiddenBooleanfalse高度溢出是否隐藏,例如 true
settings.omitBackgroundBooleantrue截图是否忽略背景,例如 false
settings.textAlignString文本对齐方式 (例如: "left", "center", "right")
settings.watermarkTextString水印文本
settings.watermarkEnabledBoolean是否启用水印,例如 false

返回参数:

参数名类型描述
typeString图片类型,例如 "png""zip" (长图分割时)。
urlString生成的图片 URL。
pagesInteger页数 (仅在 typezip 时有效)。

示例请求:

{
  "settings": {
    "templateType": "text",
    "cardWidth": 440,
    "cardHeight": 586,
    "backgroundColor": "#5352ed",
    "splitMode": "manual",
    "isDarkMode": false,
    "verticalPadding": 30,
    "horizontalPadding": 30,
    "borderRadius": 15,
    "fontFamily": "dong-shu-yuan-song",
    "textAlign": "left",
    "isContentCenter": false,
    "deviceScaleFactor":3,
    "heightOverflowHidden": true,
    "watermarkEnabled": true,
    "watermarkText": "",
    "isLongContent": false,
   
  },
  "markdownContent": "# Any2Card\n> 将 Markdown 一键转换为优雅知识卡片的工具,让技术内容轻松变身精美海报\n\n## 📖 使用指南\n1. 在编辑区输入或粘贴你的内容(支持Markdown 原生格式)\n2. 使用右侧样式面板调整背景、字体等视觉效果\n3. 使用导出按钮下载高清封面图\n\n### 💡 小技巧:\n- 根据 markdown 中的 `---` 三横线拆分卡片\n- 选中文字可出现润色按钮,点击润色可润色当前文字"
}

示例响应:

{
  "code": 0,
  "message": "success",
  "data": {
    "type": "png",
    "url": "https://your-domain.com/path/to/image.png"
  }
}

图文模式

(templateType: "image-text")

请求参数:

参数名类型必填默认值描述
markdownContentStringMarkdown 文本内容
settingsObject模板设置对象
settings.templateTypeString"imageText"模板类型,固定为 "image-text"
settings.selectedImageTextTemplateString"memo"选中的图文模板 (例如: "template1", "template2")
settings.splitModeString"long"分割模式 (例如: "auto", "manual")
settings.selectedThemeString选中的主题 多主题的模版才支持
settings.cardWidthInteger440卡片宽度 (px),例如 750
settings.cardHeightInteger586卡片高度 (px),例如 1000
settings.deviceScaleFactorInteger2像素比(清晰度),例如 1,2,3
settings.fontFamilyString"var(--font-noto-serif-sc)"字体系列,例如 "Arial, sans-serif"
settings.heightOverflowHiddenBooleanfalse高度溢出是否隐藏,例如 true
settings.omitBackgroundBooleantrue截图是否忽略背景,例如 true
settings.watermarkTextString水印文本
settings.watermarkEnabledBoolean是否启用水印,例如 false

返回参数:

与文本模式的返回参数相同。

参数名类型描述
typeString图片类型,例如 "png""zip" (长图分割时)。
urlString生成的图片 URL。
pagesInteger页数 (仅在 typezip 时有效)。

示例请求:

{
  "settings": {
    "templateType": "imageText",
    "cardWidth": 440,
    "cardHeight": 586,
    "selectedImageTextTemplate": "popart",
    "selectedTheme":"",
    "splitMode": "long",
     "deviceScaleFactor":3,
    "fontFamily": "dong-shu-yuan-song",

    "heightOverflowHidden": true,
    "watermarkEnabled": true,
    "watermarkText": "哈哈哈"

  },
  "markdownContent": "# Any2Card\n> 将 Markdown 一键转换为优雅知识卡片的工具,让技术内容轻松变身精美海报\n\n## 📖 使用指南\n1. 在编辑区输入或粘贴你的内容(支持Markdown 原生格式)\n2. 使用右侧样式面板调整背景、字体等视觉效果\n3. 使用导出按钮下载高清封面图\n\n### 💡 小技巧:\n- 根据 markdown 中的 `---` 三横线拆分卡片\n- 选中文字可出现润色按钮,点击润色可润色当前文字"
}

自定义模式

(templateType: "custom") 此模式允许用户通过自定义 CSS 和其他样式参数进行高度定制。

请求参数 (暂定):

参数名类型必填默认值描述
markdownContentStringMarkdown 文本内容
settingsObject模板设置对象
settings.templateTypeString"imageText"模板类型,固定为 "image-text"
settings.selectedCustomTemplateString"我的自定义模版"选中的自定义模板名称 (例如: "template1", "template2")
settings.splitModeString"long"分割模式 (例如: "auto", "manual")
settings.cardWidthInteger440卡片宽度 (px),例如 750
settings.cardHeightInteger586卡片高度 (px),例如 1000
settings.deviceScaleFactorInteger2像素比(清晰度),例如 1,2,3
settings.fontFamilyString"var(--font-noto-serif-sc)"字体系列,例如 "Arial, sans-serif"
settings.heightOverflowHiddenBooleanfalse高度溢出是否隐藏,例如 true
settings.omitBackgroundBooleantrue截图是否忽略背景,例如 true
settings.watermarkTextString水印文本
settings.watermarkEnabledBoolean是否启用水印,例如 false
示例请求:
{
  "settings": {
    "templateType": "custom",
    "cardWidth": 200,
    "cardHeight": 586,
    "selectedCustomTemplate": "我的主题4",
    "selectedTheme": "",
    "splitMode": "long",
    "deviceScaleFactor": 3,
    "fontFamily": "dong-shu-yuan-song",
    "heightOverflowHidden": true,
    "watermarkEnabled": true,
    "watermarkText": "哈哈哈",
    "isLongContent": false
  },
  "markdownContent": "# Any2Card\n> 将 Markdown 一键转换为优雅知识卡片的工具,让技术内容轻松变身精美海报\n\n## 📖 使用指南\n1. 在编辑区输入或粘贴你的内容(支持Markdown 原生格式)\n2. 使用右侧样式面板调整背景、字体等视觉效果\n3. 使用导出按钮下载高清封面图\n\n### 💡 小技巧:\n- 根据 markdown 中的 `---` 三横线拆分卡片\n- 选中文字可出现润色按钮,点击润色可润色当前文字"
}

返回参数:

与文本模式的返回参数相同。

积分详情

您可以在 头像 -> 设置 -> 积分详情 页面查看您的积分余额和消费历史。 每次调用 /api/generate-image 接口会消耗固定数量的积分。

调用日志

您可以在 头像 -> 设置 -> 调用日志 页面查看您的 API 调用历史记录,包括请求参数、响应结果、调用状态和耗时等信息。

如果您有任何问题或建议,欢迎随时联系我们!