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 で、オペレーション 1 つなら {"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 を渡すと、プロジェクトのコピーに適用され、そのファイルだけに反映されます。1 つのテンプレートから多数のファイルを。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

エラー

エラーは、固定の code と、アカウントの言語による detail メッセージ付きの JSON で返ります。失敗したステップでは、どのパラメーターが誤っていたかが示されます。プランのレンダリング数を使い切ると、API は 402 と quota_renders を返します。

制限

• アップロードは 50 MB、1 辺 12,000 px まで。
• キャンバスは 1 辺 20,000 px まで、かつプランのメガピクセル数の範囲内。
• 1 回の呼び出しにつき最大 200 ステップ。
• プレビューは長辺 2,048 px まで。
• メガピクセル、レイヤー、プロジェクト、ストレージ、月あたりのレンダリング数はプランによって異なります。料金をご覧ください。