API 文档

AI 智能排版 — 将原始文本自动排版为精美的小红书卡片 Markdown

认证

所有请求需要 API Key：

Authorization: Bearer tc_live_xxxxxxxxxxxx

在管理页面生成 API Key。

排版接口

POST /api/format

传入原始文本，AI 自动排版为适合小红书卡片的 Markdown 格式。

请求体

{
  "text": "原始文章内容（Markdown 或纯文本）",
  "template": "cinematic-film",
  "config": { "fontSize": 16 },
  "enhance": false
}

参数	类型	必填	说明
`text`	string	必填	原始文本，Markdown 或纯文本均可，上限 10000 字符
`template`	string	可选	模板 ID，默认 `blank`
`config`	object	可选	覆盖模板默认参数
`enhance`	boolean	可选	智能优化（纠错、润色），默认 `false`

响应

{
  "markdown": "# 排版后的标题\n\n正文内容...",
  "template": "cinematic-film",
  "enhanced": false,
  "editor_url": "https://xhs-textcard.site/editor.html?template=cinematic-film#Base64..."
}

字段	类型	说明
`markdown`	string	AI 排版后的 Markdown 文本
`template`	string	使用的模板 ID
`enhanced`	boolean	是否进行了智能优化
`editor_url`	string	可直接打开的编辑器链接，预填排版内容和模板

两种模式

模式	`enhance`	说明
排版模式	`false`（默认）	仅排版，不修改原文措辞。自动加标题、分页、加粗重点、拆分段落
智能优化	`true`	排版 + 修正错别字 + 润色措辞，保留原文核心意思

示例

# 排版模式（仅排版，不改文案）
curl -X POST https://xhs-textcard.site/api/format \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tc_live_xxx" \
  -d '{"text":"今天给大家分享一个超好用的方法第一步先准备好材料第二步按照说明操作","template":"blank"}'

# 智能优化模式（排版 + 纠错 + 润色）
curl -X POST https://xhs-textcard.site/api/format \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tc_live_xxx" \
  -d '{"text":"今天给大家分想一个超好用的方发","template":"blank","enhance":true}'

内置模板

ID	名称	风格
`blank`	空白模板	纯白极简
`polaroid`	复古拍立得	手写楷体
`notion-style`	效率笔记	Notion 风格
`elegant-book`	书籍内页	宋体排印
`ios-memo`	苹果备忘录	iOS 原生
`swiss-studio`	苏黎世工作室	瑞士设计
`minimalist-magazine`	极简杂志	杂志排版
`aura-gradient`	弥散极光	渐变背景
`deep-night`	暗夜深思	深色终端
`pro-doc`	大厂文档	企业文档
`cinematic-film`	电影胶片	胶片质感
`starry-night`	星光质感	星空深蓝

模板配置参数

通过 config 对象覆盖模板默认值，仅传需要修改的字段。

基础参数

参数	类型	范围	说明
`bgColor`	string	颜色值	背景颜色
`textColor`	string	颜色值	文字颜色
`fontSize`	number	12–32	正文字号
`lineHeight`	number	1.2–3.0	行高
`letterSpacing`	number	0–3	字间距
`textPadding`	number	20–80	文字区域边距

扩展参数

参数	类型	说明
`fontFamily`	string	字体族
`accentColor`	string	强调色（标题、高亮）
`h1Scale`	number	一级标题缩放 (1.0–5.0)
`h2Scale`	number	二级标题缩放 (1.0–4.0)
`h3Scale`	number	三级标题缩放 (1.0–3.0)
`hasWatermark`	boolean	显示水印
`watermarkText`	string	水印文字
`hasSignature`	boolean	显示签名
`signatureText`	string	签名文字
`showPageNumber`	boolean	显示页码

辅助接口

GET /api/templates

获取模板列表。

curl https://xhs-textcard.site/api/templates

GET /api/templates?id=cinematic-film

获取指定模板的完整默认配置。

错误码

HTTP	error	说明
400	`invalid_json`	请求体 JSON 格式错误
400	`missing_param`	text 字段缺失
401	`unauthorized`	缺少或无效的 API Key
413	`payload_too_large`	text 超过 10000 字符
429	`rate_limited`	超过每日限额
500	`ai_error`	AI 服务暂时不可用

限制

每个 Key 每日 50 次请求
文本上限 10000 字符

在飞书多维表格中使用

通过飞书多维表格的「自动化」功能，批量调用排版 API，自动生成排版后的 Markdown 和预览链接。

准备工作

一个有效的 API Key（在管理页面生成）
飞书多维表格中准备好文案列

自动化配置

打开多维表格 → 「自动化」 → 新建规则
触发条件：当某行记录的「状态」列变为「待排版」
执行动作：选择「发送 HTTP 请求」
配置请求：
- 方法：POST
- URL：https://xhs-textcard.site/api/format
- Header：Authorization: Bearer tc_live_xxx
- Header：Content-Type: application/json
- Body：使用变量插值填入文案

请求体示例

{
  "text": "{{文案列}}",
  "template": "cinematic-film",
  "enhance": false
}

响应处理

API 返回两个字段，写回飞书多维表格：

markdown → 写入「排版结果」列（文本类型）
editor_url → 写入「预览链接」列（超链接类型）

用户点击 editor_url 链接即可在浏览器中查看排版效果，并使用编辑器内置的下载功能导出图片，无需服务端渲染。

提示：开启 "enhance": true 可自动修正错别字和润色措辞。如只需排版不改文案，保持默认的 false 即可。

中间服务示例（适合批量场景）

# Node.js / Cloudflare Worker 中间服务示例
async function formatAndWrite(row) {
  const resp = await fetch('https://xhs-textcard.site/api/format', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer tc_live_xxx'
    },
    body: JSON.stringify({
      text: row.text,
      template: row.template || 'blank',
      enhance: false
    })
  });

  const data = await resp.json();
  if (!resp.ok) throw new Error(data.message);

  // 写回飞书：排版文本 + 预览链接
  await updateFeishuRow(row.id, {
    formatted_text: data.markdown,
    preview_url: data.editor_url
  });
}

注意事项

每个 Key 每日限额 50 次，批量使用请注意配额
editor_url 中文案通过 URL hash 传递，不会发送到服务器
建议在多维表格中增加「状态」列标记排版进度，避免重复调用