API 文档

Nordic Layers 是部署在 https://app.layers.nordicbyte.co.uk 的 HTTPS REST API。项目是由图层组成的 JSON 文档；你用操作修改它，并将其导出为图片。浏览器编辑器使用的是同一套 API。

身份验证

在账户面板中创建 API 密钥，并在每个 /v1 请求中携带。密钥以 nl_key_ 开头。

Authorization: Bearer nl_key_…

常规流程

1. 上传：用 POST /v1/assets 上传每张图片，文件作为原始请求体（PNG、JPEG、WebP、GIF、BMP 或 TIFF）。返回结果中带有它的 id。
2. 创建：用 POST /v1/projects 创建项目，并提供 width、height 和 background。也可以在同一次调用中传入最初的 steps。
3. 编辑：用 POST /v1/projects/{id}/run，单个操作写成 {"op": …}，多个操作写成 {"steps": [...]}。用免费的 GET /v1/projects/{id}/preview 查看效果。
4. 导出：用 POST /v1/projects/{id}/export。返回结果包含文件 URL；如果指定 "response": "image"，则直接返回图片本身。

第一个请求

创建一个带渐变和标题的 1080×1080 项目，然后导出为 WebP：

curl -X POST https://app.layers.nordicbyte.co.uk/v1/projects \
  -H "Authorization: Bearer $NL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "First post",
    "width": 1080,
    "height": 1080,
    "steps": [
      {"op": "layer.addFill", "gradient": {"colors": ["#1E3A5F", "#64B5F6"], "angle": 135}},
      {"op": "text.add", "content": "Hello, layers", "fontName": "Segoe UI", "fontSize": 110, "bold": true, "color": "#FFFFFF"},
      {"op": "effects.set", "shadow": {"opacity": 0.4, "distance": 12, "size": 24}}
    ]
  }'

# → {"project": {"id": "…", …}}

curl -X POST https://app.layers.nordicbyte.co.uk/v1/projects/$PROJECT_ID/export \
  -H "Authorization: Bearer $NL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "webp",
    "quality": 90
  }'

接口

操作

每个操作都是带有 op 及其参数的对象。图层通过 id 或名称引用；省略 layer 时使用当前活动图层。名称不区分大小写和空格，因此 "Linear Dodge (Add)" 与 "linearDodge" 是同一种混合模式。使用 steps 时按顺序执行，遇到第一个错误即停止（除非设置 "stopOnError": false）；出错之前的步骤依然生效。

• 图层
• 文字
• 形状
• 变换
• 图层调整
• 滤镜
• 调整图层
• 图层蒙版
• 图层效果
• 画布
• 项目

图层

文字

形状

变换

图层调整

滤镜

调整图层

图层蒙版

图层效果

画布

项目

混合模式

• normal
• darken
• multiply
• colorBurn
• linearBurn
• lighten
• screen
• colorDodge
• linearDodge
• overlay
• softLight
• hardLight
• difference
• exclusion
• subtract
• divide
• hue
• saturation
• color
• luminosity

字体家族

• Arial
• Segoe UI
• Calibri
• Verdana
• Tahoma
• Trebuchet MS
• Georgia
• Times New Roman
• Courier New
• Consolas
• Impact
• Comic Sans MS

模板

向导出调用传入 steps，这些步骤只会应用到项目的副本上，仅作用于该文件。一个模板，多个文件：用 text.set 更换文字，用 layer.setImage 更换照片，图层的框保持不变。

curl -X POST https://app.layers.nordicbyte.co.uk/v1/projects/$TEMPLATE_ID/export \
  -H "Authorization: Bearer $NL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "png",
    "steps": [
      {"op": "text.set", "layer": "Title", "content": "Nueva colección"},
      {"op": "layer.setImage", "layer": "Photo", "asset_id": "photo_dunes"}
    ]
  }'

无状态渲染

POST /v1/render 接收完整的 document（即 project.document 中返回的内容）、可选的 steps 和导出选项，不会保存项目。指定 "response": "image" 时，返回的就是图片文件。

curl -X POST https://app.layers.nordicbyte.co.uk/v1/render \
  -H "Authorization: Bearer $NL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document": {"width": 1200, "height": 630, "background": "#1E3A5F", "layers": ["…"]},
    "format": "png",
    "response": "image"
  }' \
  -o card.png

错误

错误以 JSON 形式返回，带有稳定的 code 和以你账户语言书写的 detail 信息。步骤失败时会指出哪个参数有误。套餐的渲染次数用完后，API 返回 402 和 quota_renders。

限制

• 上传最大 50 MB，每边最大 12,000 px。
• 画布每边最大 20,000 px，且不超过套餐的兆像素上限。
• 每次调用最多 200 个步骤。
• 预览长边最大 2,048 px。
• 兆像素、图层、项目、存储空间和每月渲染次数取决于套餐：详见价格。