Files
probably-rendering-one-more…/content/studio-tools/layouts-api.md
T
codex-bot 174a3ef266
studio CI and deployment / verify-and-deploy (pull_request) Failing after 3m51s
waterfall-wiki CI and deployment / verify-and-deploy (pull_request) Failing after 2m58s
Add versioned multi-page Studio artwork documents and native exports
2026-10-28 23:36:54 +08:00

20 KiB
Raw Blame History

Studio 排版 API · 标准图文与 27 套固定构图

把本篇与图片生成文档一起交给 coding agent。agent 自行选择图片、配色、字体、构图与参数,通过 HTTP 保存渲染描述,得到可持续更新的原生 HTML/CSS 页面。数据库只保存模板关联、文字、素材引用和渲染参数,不保存截图或任意 HTML。

可选:查看模板示例 · 读取实时 API 契约 · 照片入皮影 · 街头小人

agent 的交付流程

  1. 按下文读取模板 API,选择 layoutId,并获取该模板实际的 T/I/D 元素 ID。
  2. 上传图片取得 assetId,把图片、文字和参数提交给创建 API。
  3. 从创建响应读取 design.id 与 design.url,把完整结果链接交给用户,例如 http://8.211.154.134:18131/studio/template-layout?id=实际返回的UUID。
  4. 用户直接打开该链接看结果;修改内容继续调用 PATCH,同一 ID 与结果链接保持不变。

不要编造 ID,也不要把模板预览链接当作最终结果。API 保存成功并返回真实 UUID 才算完成。以下文档足以通过 HTTP 完成流程,无需使用编辑器。

多页作品:从创作 brief 到可发布文件(schemaVersion 2)

多页作品由 coding agent 完成创作决策与图像生成,网站负责封闭参数验证、事务保存与原生渲染。无需模型服务、模型密钥或编辑器。先形成主题、读者、意图、逐页分镜,再生成需要的图片,最后通过 HTTP 保存整组作品。封面、正文、结尾共用一个真实 UUID、修订号和 Wiki post。

完整内容与视觉模型

创建 POST /api/studio/series,body 为 {schemaVersion:2,name,document}。读取/整体修订使用 GET/PATCH /api/studio/series/{id};PATCH 额外提供最新 revision。最大512KB,未知字段会拒绝。document:

  • version:1:多页文档结构版本。
  • brief:topic、audience、intent、designIntent、imageStrategy,均为必填非空文字,最多2000字符。分别说明主题、读者、内容目标、完整设计描述和配图策略。
  • style.version:agent 指定的样式版本标识(最多80字符),如 autumn-journal/1。它用于记录创作版本;不锁定未来网站渲染器,精确交付请同时保留导出文件和 manifest。
  • style.palette:paper、ink、muted、accent,均为 #RRGGBB。
  • style.typography:title、body、caption 三种层级,每项包含 fontFamily(sans/serif/mono)、fontSize(0.1–40)、fontWeight(100–900)、lineHeight(0.5–4)、letterSpacing(-5–10)。字号和字距以120宽参考画板为单位,固定模板按画板宽度同比换算。
  • style.spacing:margin(4–16)、gap(1–10),并要求 2*margin+4*gap<=48。标准排版据此计算标题、图片、正文和分隔线的位置;固定模板保留原构图,用 layers 显式调整位置。
  • sources:最多100项,每项 assetId、author、license、url、prompt、tool 全部必填,文字最多4000字符。url 是 http(s) 来源地址或 generated。用户照片记录来源与授权;生成图记录完整提示词和工具,不把 AI 图写成摄影原作。所有被页面引用的图片必须有来源记录。
  • pages:本工作流支持3–18页(这是本服务的约束,不宣称是平台实时上限)。每页 key 唯一(小写字母/数字/连字符,最多60位)、role(首项 cover,中间 body,末项 ending)、layoutId、intent(最多1000字符)、bindings、parameters。parameters 继续使用下文封闭的单页参数契约。
  • pages[].bindings:把实际文字元素 ID 映射到 title/body/caption,例如 {T01:"title",T02:"body",T03:"caption"}。被绑定元素必须提供文案。共享字体、墨色和纸色会参与真实渲染;单元素显式值优先覆盖。所有可见文字必须提供或明确隐藏,避免默认占位文案泄漏。图片默认色与装饰默认色取 accent。

标准排版可直接沿用 T01/T02/T03/I01/D01;固定排版先读对应模板 API,元素不能混用。agent 必须控制标题长度和正文密度,不能把“已保存”当成“已验收”。同组图片建议统一比例;导出器遇到混合比例会拒绝,agent 应改用同一画板并调整内容布局。

一次保存,一条直接结果链接

# series.json 包含完整 document,示例文件见仓库 content/studio-examples/autumn-journal.json
curl -fsS -X POST "$BASE/api/studio/series" \
 -H "Authorization: Bearer $PROMPT_TOKEN" -H 'Content-Type: application/json' \
 --data-binary @series.json
# 返回 {design}:schemaVersion=2、document、id、revision、url、postId 等
curl -fsS -H "Authorization: Bearer $PROMPT_TOKEN" "$BASE/api/studio/series/$ID"

创建响应的 design.url 仍是 /studio/template-layout?id={UUID};直接展示全部页,无需选模板。&page=2 只显示第2页,非法页码返回404。页面是服务端原生文字与 CSS,图片走 /api/preview。创建与全部页验证、Wiki post 处于同一事务,任一页无效整组不保存。PATCH 整体替换 document,revision 冲突返回409;先重新读取并合并。单页 PATCH 接口会拒绝修改多页作品,避免只改封面导致组内不一致。可从 designs 列表发现作品,schemaVersion 区分1与2。

归档 DELETE /api/studio/series/{id} body {revision};恢复 POST 同一路径 body {revision,archived:false}。归档后结果页和导出计划返回404,API 仍能读取并恢复;参数、素材和 Wiki post 保留。更新复用原 Wiki post,手工编辑过的正文不被覆盖。

高质量导出与验收

GET /api/studio/series/{id}/export 返回固定顺序的导出计划:id、revision、每页 key/role/number、filename、width/height、原生渲染 url。计划本身不生成位图。示例统一为3:4、1080×1440 PNG;其他固定模板保留自己的画板比例,不拉伸。该尺寸是本流程的交付规格;发布前还须在小红书当前发布界面复核裁切及文件限制,本站不自动发布。

导出 URL 带 &page=N&export=1,画布在1080 CSS像素下重新布局原生文字,不把860宽或手机截图放大。图片使用 /api/preview?source=...&width=2160&profile=export:WebP质量95,不为常规缩略图预算降低尺寸,不放大小原件。普通展示仍使用240/480/960/1280及100KB/220KB预算。

在用户已确认的 ces-control / aliyun-ces-control 上运行仓库 scripts/export-studio-series.cjs,使用既有测试镜像的 playwright-core、sharp、Chromium 和中文字体。只访问 http://8.211.154.134:18131,认证保留进程内。设置 STUDIO_DESIGN_ID、STUDIO_EXPORT_DIR、AUTH_CONFIG_FILE(或由现有登录方式提供的 PROMPT_TOKEN),不在命令行或文件中存令牌。不得在用户本机启动编译、容器构建或预览服务器。

脚本逐页检查字体和图片加载、文字溢出、图片原生分辨率与裁切缩放、相同画板比例、页序、最终PNG像素、导出前后revision一致;记录实际字体、SHA256及manifest。额外生成桌面1200宽和手机390宽整组截图供视觉检查。自动检查通过后,agent 仍须逐页看PNG,核对中文缺字、主体裁切、阅读顺序、留白和系列一致性。检查失败修订 document,重新导出;不能把失败文件当成可发布结果。

最终交付:真实设计结果链接、按01/02/03排序的PNG、完整design.json、manifest.json、素材来源与提示词、简短发布文案。生成图、保存成功、导出成功、人工视觉通过、PR待合并、线上部署验收应分别如实报告。未合并代码的能力不可写成线上已可用。

可复现三页示例

仓库 content/studio-examples/autumn-journal.json 是完整的三页内容与样式文档:封面“把秋天装进一页”、正文“先看见再记录”、结尾“留一点白给下一次”。它不含虚构素材 UUID,空图片位仅用于契约测试。真实制作时先生成银杏母图,再上传取得assetId,在每页 I01 加入该 UUID,并在 sources 记录完整来源。不要把无图夹具当作已完成作品。

node /app/auth-cli.cjs run /delivery/scripts/save-studio-series.mjs /absolute/path/series.json /absolute/path/ginkgo-master.png /absolute/path/provenance.json /absolute/path/output-directory 经既有 auth-cli run 在远程执行,上传素材并填写所有页面引用后,保存真实作品,写出请求、响应和状态文件。重复运行会读取已保存状态,防止在成功后重复创建;出现网络结果不明时先核对素材/设计列表,不盲目重试。脚本仅在传入文件后写入作品,不自动发布到小红书。

两类排版,同一内容模型

  • 标准排版:standard-01,120×160 单位。沿用原 Studio 图文页的标题、正文、栏目结构,增加主题图片与分隔线。T01 主标题、T02 正文、T03 栏目、I01 图片、D01 分隔线。所有内容和位置可设置,也能增加原生元素。
  • 固定排版:ref-01 至 ref-27,保留各自画板、出血、圆形、斜切、竖题和字体构图。先读取模板,按实际 T/I/D ID 填入内容。不能假定各模板拥有相同元素。

两类单页都使用 /api/studio/designs 的真实 CRUD。创建额外指定 layoutId;更新从 URL 确定 ID,模板关联不能修改。更换模板应创建新记录,避免把旧元素 ID 错套到新模板。调用方无需打开 /studio 或操作编辑器。模板由 agent 经 API 选择,图片和文字由 API 保存,用户只打开结果链接。现有独立工具箱功能保持可用。

1. 由 agent 通过 API 发现模板

以下 curl 使用指定服务器。PROMPT_TOKEN 由用户通过现有登录方式提供,只保存在进程环境,不放 URL 或日志。也可使用已登录浏览器的同源 Cookie;浏览器写请求需要同源 Origin。未登录 API 返回 401。

BASE=http://8.211.154.134:18131
curl -fsS -H "Authorization: Bearer $PROMPT_TOKEN" "$BASE/studio/api/layouts"
curl -fsS -H "Authorization: Bearer $PROMPT_TOKEN" "$BASE/studio/api/layouts/standard-01"
curl -fsS -H "Authorization: Bearer $PROMPT_TOKEN" "$BASE/studio/api/layouts/ref-17"

目录返回 version, layouts, saveApi, catalogUrl, documentationUrl。每项包含 id,name,family,url,api,family 为 standard/fixed。模板返回尺寸、元素 ID/类型/role/box/direction/text、默认 parameters、workspaceSchema 与页面 URL。?agent_mode=True 返回纯文本文档,业务请求移除此参数。

2. 生成图片,上传一次,显示压缩衍生图

先让 coding agent 按生成图片文档产出文件;Studio 不暗中调用生成模型。图片可以来自用户素材或生成结果。上传走现有素材 API:

curl -fsS -H "Authorization: Bearer $PROMPT_TOKEN" \
  -F kind=image -F assetOnly=true -F files=@hero.png "$BASE/api/upload"

返回 assets UUID 数组及对应 files 元数据。取 assets[0] 作为 assetId。上传不单独发帖;设计创建时才自动关联 Wiki post。不要把 Base64、任意远程 URL、HTML 或 SVG 塞入参数。

原素材保留在素材库,页面展示只请求压缩 WebP。以 assetId 引用素材,不必自行再上传缩略图:

curl -fsS -H "Authorization: Bearer $PROMPT_TOKEN" \
  "$BASE/api/preview?source=%2Fapi%2Fmedia%2FASSET_UUID&width=960" -o hero-preview.webp

width 只允许 240/480/960/1280;小图预算 100KB,大图预算 220KB,复杂图片会降低尺寸/质量。原生页面按槽位显示宽度和像素密度选择 srcset 衍生图,保留 fit/cropX/cropY/zoom。目录使用原生文字与 CSS 色块,不加载参考原图;旧工具箱参考图也使用压缩预览。/api/media/{id} 是素材原件读取接口,不应用作展示图片的 src。

3. 创建:POST /api/studio/designs

创建和更新共用内容字段 name,parameters;schemaVersion 可省略,单页当前支持 1(多页使用上述独立 series API 的2)。创建额外传 layoutId,不传 revision 或 id。

curl -fsS -X POST "$BASE/api/studio/designs" \
  -H "Authorization: Bearer $PROMPT_TOKEN" -H 'Content-Type: application/json' \
  -d '{"schemaVersion":1,"layoutId":"standard-01","name":"观察日常","parameters":{"paper":"#edf0ef","texts":{"T01":{"value":"观察日常\n记录灵感","fontFamily":"serif","color":"#23424b"},"T02":{"value":"让每一页只讲一件事。","lineHeight":1.4}},"images":{"I01":{"color":"#73929a","fit":"cover","cropX":50,"cropY":45,"zoom":1}},"decorations":{"D01":{"color":"#73929a"}}}}'

有图片时在 I01 加 assetId:"上传返回的UUID"。固定排版只需改为所选 layoutId,并按 schema 选择元素 ID。例如 ref-01 支持 texts.T01、texts.T02 与 images.I01。

201 返回 {design}。design 包含:

字段 含义
id / layoutId / family 持久化 UUID、不可变模板 ID、standard 或 fixed
schemaVersion / revision 参数契约版本(1)、记录修订号(从1递增)
name / parameters 名称与规范化内容;省略的分组返回空对象
url / renderUrl 同一个原生 HTML/CSS 页面 URL
schemaUrl 当前模板参数地址
postId / postUrl 自动创建并在后续更新中复用的 Wiki post
archived / archivedAt 可恢复归档状态与时间
createdAt / updatedAt 创建与最后修改时间
legacySvgUrl 固定排版的旧 SVG 导出地址,标准排版为 null

创建设计与 Wiki post 在同一数据库事务内完成,失败整体回滚。更新同一设计复用同一 post;手工编辑过的 Wiki 正文、标题、标签、封面不会被参数更新覆盖。

4. 读取与打开

ID=创建返回的UUID
curl -fsS -H "Authorization: Bearer $PROMPT_TOKEN" "$BASE/api/studio/designs/$ID"
curl -fsS -H "Authorization: Bearer $PROMPT_TOKEN" "$BASE/api/studio/designs?layoutId=standard-01&limit=20"

读取返回 {design},没有副作用。列表默认只列未归档记录;archived=true 只列归档记录;limit 为1–50,默认20;nextCursor 作为下一页 before。layoutId 可省略。

直接打开创建响应中的 design.url:/studio/template-layout?id={UUID}。这个 UUID 对应数据库里 API 保存的模板、图片与文字,服务端按记录渲染最终 HTML/CSS。链接中无需携带 layoutId,无需打开 /studio 选择模板,也没有编辑按钮、双击编辑或右键编辑。standard-01 与 ref-17 是模板 ID,不是保存记录的 UUID。

/studio/designs/{UUID} 与旧 /studio/layouts/{layoutId}?id={UUID} 兼容跳转到同一个结果页。缺失、非法、不存在或已归档的 ID 返回404,不会显示空模板或编辑器;旧链接模板与记录不匹配也返回404。归档设计仍能经 API 读取以恢复。

5. 更新:PATCH /api/studio/designs/{id}

先 GET,保留所有未改字段,再整体替换 parameters;不是深度合并。以下假设刚读到 revision=1:

curl -fsS -X PATCH "$BASE/api/studio/designs/$ID" \
  -H "Authorization: Bearer $PROMPT_TOKEN" -H 'Content-Type: application/json' \
  -d '{"name":"观察日常 · 修订","revision":1,"parameters":{"texts":{"T01":{"value":"新的标题"}},"images":{},"decorations":{}}}'

200 返回新 design,revision 增加。过期 revision 返回409,重新 GET 并合并后再提交;不要盲目重试。不接受 layoutId、id、url、postId 等返回字段;不能直接把整个 design 作为 body。另存副本使用 POST 创建新 UUID。

6. 删除与恢复

DELETE 采用可恢复归档,不物理删除参数、素材或 Wiki post。和更新一样必须提供最新 revision;自动同步关联 post 的归档状态。

curl -fsS -X DELETE "$BASE/api/studio/designs/$ID" \
  -H "Authorization: Bearer $PROMPT_TOKEN" -H 'Content-Type: application/json' -d '{"revision":2}'
# 删除后读取新 revision,再恢复。此例删除后为3:
curl -fsS -X POST "$BASE/api/studio/designs/$ID" \
  -H "Authorization: Bearer $PROMPT_TOKEN" -H 'Content-Type: application/json' -d '{"revision":3,"archived":false}'

两者200返回 {design},revision 递增。归档记录 PATCH 返回409,先恢复。重复写入仍需最新 revision;409不会修改数据。独立归档 Wiki post 只影响笔记发现状态,不等于删除设计。旧设计缺 Wiki 入口可调用 POST /api/studio/designs/{id}/post,body {},首次201、已有200;不改变 revision。

参数清单(两类共用)

parameters 顶层允许 texts/images/decorations/paper/layers/added;全部可省略,不能添加未知字段。最大请求64KB。颜色都为 #RRGGBB。坐标与字号使用模板单位,不是 CSS 像素。

分组 字段与约束
texts.{文字ID} value 必填,可空,最多500字/8行;color;scale 0.25–2;align start/middle/end;fontFamily sans/serif/mono;fontSize 0.1–1000;fontWeight 100–900;lineHeight 0.5–4;letterSpacing -20–100
images.{图片ID} assetId(已存在的图片 UUID);color;fit cover/contain;cropX/cropY 0–100(默认50);zoom 1–5(默认1)
decorations.{装饰ID} color;hidden 布尔值
paper 纸张颜色
layers.{元素ID} x/y -10000–10000;width/height 0.1–10000;rotation -360–360;opacity 0–1;radius 0–5000;z -1000–1000;hidden/locked 布尔值
added 最多100项:id 为 user- 加1–60位字母/数字/连字符,唯一;kind text/image/decoration;role 最多80字;box 为 [x,y,width,height];direction 必须 horizontal;text 为文字或null;reading 必须 custom;装饰可带 shape rectangle/ellipse

新增元素先在 added 声明,然后在 texts/images/decorations/layers 用该 ID 配置。locked 控制工作区交互,不禁止 agent 更新。数据是封闭结构,无脚本执行。未来扩展新增契约版本;v1 不接受未知字段/版本。现有省略 schemaVersion 的请求继续按v1处理,旧记录无需重建,布局 ID 和页面 UUID 保持不变。默认视觉可随模板美化变化;要求固定外观时显式设置配色、字体和图层参数。

错误:400 参数/版本/构件类型/图片 ID 不合法;401 未登录;404 模板或设计不存在;409 修订冲突或已归档;405 方法不支持;413 请求超限;500 服务失败。压缩预览失败可能返回503与 Retry-After。

现有工具箱与兼容导出

工具功能保留:ref-17 同一母版四张试版、ref-01/07/26 三种构图试版、最初图文页。旧封面工具文档已合并到本篇,旧文档 URL 保留为归档说明,避免重复顶级入口。

旧无状态 API:/studio/api/export/learning-skills-template 和 /studio/api/export/layout-selection 支持 GET/POST,不保存设计。前者参数 slide=0..3、heading(1–6字)、body(最多360字/3行)、color/accent、masthead(2项);后者 layoutId=ref-01/ref-07/ref-26、fields(对应T ID,1–120字/4行)、color/accent。GET 默认返回方案 JSON;GET format=svg 导出初始图;POST format=svg(默认)导出 SVG,format=json 返回参数,最大32KB。first-idea 仅支持 GET 方案/Markdown。

curl -fsS -X POST "$BASE/studio/api/export/learning-skills-template?format=svg" \
  -H "Authorization: Bearer $PROMPT_TOKEN" -H 'Content-Type: application/json' \
  -d '{"slide":1,"heading":"笔记复习","color":"#7a8b7e"}' -o cover.svg
curl -fsS -X POST "$BASE/studio/api/export/layout-selection?format=svg" \
  -H "Authorization: Bearer $PROMPT_TOKEN" -H 'Content-Type: application/json' \
  -d '{"layoutId":"ref-01","fields":{"T01":"STUDY"},"color":"#83918a"}' -o selection.svg

固定排版 /studio/api/layouts/ref-01 的 GET format=svg、POST 仍提供旧分层 SVG;POST format=json 只验证和返回规范化参数。旧 SVG 不反映 added、layers、扩展字体和裁切参数,不能用来证明原生效果。standard-01 不支持 SVG。原生页面应直接打开返回 URL,;多页可按上文通过导出器生成PNG。代码可扩展渲染能力,但每次是否使用、选择哪些参数均由 coding agent 决定。

固定排版索引

{{LAYOUTS}}