API डॉक्यूमेंटेशन

Nordic Layers https://app.layers.nordicbyte.co.uk पर HTTPS के ऊपर एक REST API है। प्रोजेक्ट लेयर्स का एक JSON दस्तावेज़ है; आप उसे ऑपरेशन से बदलते हैं और इमेज के रूप में एक्सपोर्ट करते हैं। ब्राउज़र एडिटर यही API इस्तेमाल करता है।

ऑथेंटिकेशन

अपने अकाउंट पैनल में API कुंजी बनाएँ और हर /v1 रिक्वेस्ट के साथ भेजें। कुंजियाँ nl_key_ से शुरू होती हैं।

Authorization: Bearer nl_key_…

आम प्रक्रिया

अपलोड करें हर इमेज को POST /v1/assets से, फ़ाइल को रॉ रिक्वेस्ट बॉडी में रखकर (PNG, JPEG, WebP, GIF, BMP या TIFF)। जवाब में उसका id आता है।
बनाएँ एक प्रोजेक्ट POST /v1/projects से, width, height और background के साथ। पहले steps उसी कॉल में दे सकते हैं।
एडिट करें POST /v1/projects/{id}/run से: एक ऑपरेशन {"op": …} के रूप में या कई {"steps": [...]} के रूप में। उसे GET /v1/projects/{id}/preview से देखें, जो मुफ़्त है।
एक्सपोर्ट करें 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
  }'

एंडपॉइंट

मेथड	पाथ	यह क्या करता है
`GET`	`/health`	सर्विस की स्थिति
`GET`	`/v1/ops`	हर ऑपरेशन और उसके पैरामीटर का कैटलॉग (सार्वजनिक)
`POST`	`/v1/assets?name=photo.jpg`	इमेज अपलोड करें; बॉडी ही फ़ाइल है
`GET`	`/v1/assets`	आपकी इमेज की सूची और यह कि कोई प्रोजेक्ट उन्हें इस्तेमाल करता है या नहीं
`DELETE`	`/v1/assets/{id}`	इमेज हटाएँ
`POST`	`/v1/projects`	प्रोजेक्ट बनाएँ (कैनवास, या पूरा दस्तावेज़, और वैकल्पिक स्टेप्स)
`GET`	`/v1/projects`	आपके प्रोजेक्ट की सूची
`GET`	`/v1/projects/{id}`	एक प्रोजेक्ट उसके दस्तावेज़ के साथ
`PUT`	`/v1/projects/{id}/document`	पूरा दस्तावेज़ बदलें
`POST`	`/v1/projects/{id}/run`	एक ऑपरेशन या स्टेप्स की सूची लागू करें
`POST`	`/v1/projects/{id}/undo`	आख़िरी बदलाव अनडू करें
`POST`	`/v1/projects/{id}/redo`	रीडू
`GET`	`/v1/projects/{id}/preview?size=1024`	मुफ़्त PNG प्रीव्यू, लंबा किनारा `size` px तक
`POST`	`/v1/projects/{id}/export`	PNG, JPEG या WebP एक्सपोर्ट; सिर्फ़ इस फ़ाइल के लिए वैकल्पिक स्टेप्स
`POST`	`/v1/render`	पूरे दस्तावेज़ का स्टेटलेस रेंडर
`GET`	`/v1/exports`	आपके एक्सपोर्ट की सूची
`GET`	`/v1/exports/{id}/file`	एक्सपोर्ट डाउनलोड करें
`DELETE`	`/v1/projects/{id}`	प्रोजेक्ट हटाएँ

ऑपरेशन

हर ऑपरेशन op और उसके पैरामीटर वाला ऑब्जेक्ट है। लेयर्स को id या नाम से चुना जाता है; layer न देने पर सक्रिय लेयर इस्तेमाल होती है। नामों में अक्षर-भेद और स्पेस की अनदेखी होती है, इसलिए "Linear Dodge (Add)" और "linearDodge" एक ही ब्लेंड मोड हैं। steps के साथ वे क्रम से चलते हैं और पहली त्रुटि पर रुक जाते हैं (जब तक "stopOnError": false न हो); उससे पहले के स्टेप्स लागू रहते हैं।

लेयर्स
टेक्स्ट
शेप
ट्रांसफ़ॉर्म
लेयर पर एडजस्टमेंट
फ़िल्टर
एडजस्टमेंट लेयर्स
लेयर मास्क
लेयर इफ़ेक्ट
कैनवास
प्रोजेक्ट

लेयर्स

ऑपरेशन	पैरामीटर	यह क्या करता है
`layer.add`	`color, name`	Alias of layer.addFill (the web has no empty pixel layers).
`layer.addFill`	`color \| gradient {colors: [..], angle, type: linear\|radial}, name, above, atBottom`	A colour or gradient layer the size of the canvas.
`layer.addImage`	`asset_id \| color, name, rect \| origin \| center, width, height, fit (stretch\|contain\|cover), fitCanvas (contain\|cover), above, atBottom, opacity, blendMode`	Add an uploaded image (asset_id) or a solid colour (color).
`layer.clip`	`layer`	Clip a layer to the one below it (clipping mask).
`layer.delete`	`layer \| layers`	Delete layers.
`layer.duplicate`	`layer, name`	Copy a layer above itself.
`layer.get`	`layer`	One layer with all its settings.
`layer.list`	—	Layers from bottom to top.
`layer.move`	`layer, above \| below (layer), toTop, atBottom, index, offset`	Reorder a layer.
`layer.rename`	`layer, name`	Rename a layer.
`layer.select`	`layer`	Make a layer the active one.
`layer.setBlendMode`	`layer \| layers, blendMode (normal, darken, multiply, colorBurn, linearBurn, lighten, screen, colorDodge, linearDodge, overlay, softLight, hardLight, difference, exclusion, subtract, divide, hue, saturation, color, luminosity)`	Blend mode.
`layer.setFill`	`layer, color \| gradient`	Change a fill layer's colour or gradient.
`layer.setImage`	`layer, asset_id, fit (stretch\|contain\|cover)`	Replace a layer's image and keep its box (templates).
`layer.setOpacity`	`layer \| layers, opacity`	Layer opacity, 0 to 1.
`layer.setVisible`	`layer \| layers, visible`	Show or hide layers.
`layer.unclip`	`layer`	Release a clipping mask.

टेक्स्ट

ऑपरेशन	पैरामीटर	यह क्या करता है
`text.add`	`content, fontName, fontSize, color, alignment, leading, bold, italic, boxWidth, origin \| center, name`	Add a text layer.
`text.defaults`	—	Fonts on the server and whether complex scripts are shaped.
`text.set`	`layer, content, fontName, fontSize, color, alignment, leading, bold, italic, boxWidth`	Change a text layer.

शेप

ऑपरेशन	पैरामीटर	यह क्या करता है
`shape.add`	`shape, rect \| from+to, color, cornerRadius, lineWidth, name`	Add a rectangle, ellipse or line.
`shape.set`	`layer, color, cornerRadius, lineWidth`	Change a shape layer.

ट्रांसफ़ॉर्म

ऑपरेशन	पैरामीटर	यह क्या करता है
`transform.flip`	`layer \| layers, axis (horizontal\|vertical)`	Flip horizontally or vertically.
`transform.move`	`layer \| layers, dx, dy \| to [x, y]`	Move by dx/dy or to a point.
`transform.rotate`	`layer \| layers, angle`	Rotate by an angle (degrees, clockwise).
`transform.scale`	`layer \| layers, factor \| percent \| width \| height`	Scale around each layer's centre.
`transform.set`	`layer \| layers, x, y, width, height, rotation, flipX, flipY`	Box, rotation and flips.

लेयर पर एडजस्टमेंट

ऑपरेशन	पैरामीटर	यह क्या करता है
`adjust.blackWhite`	`layer \| layers, reds, yellows, greens, cyans, blues, magentas, tint, tintHue, tintSaturation`	Non-destructive blackWhite on a layer (adds it or updates it).
`adjust.brightnessContrast`	`layer \| layers, brightness, contrast`	Non-destructive brightnessContrast on a layer (adds it or updates it).
`adjust.clear`	`layer \| layers`	Remove every adjustment and filter from a layer.
`adjust.colorBalance`	`layer \| layers, shadows, midtones, highlights, preserveLuminosity`	Non-destructive colorBalance on a layer (adds it or updates it).
`adjust.curves`	`layer \| layers, rgb, red, green, blue`	Non-destructive curves on a layer (adds it or updates it).
`adjust.exposure`	`layer \| layers, exposure, offset, gamma`	Non-destructive exposure on a layer (adds it or updates it).
`adjust.gradientMap`	`layer \| layers, shadows, highlights, reversed`	Non-destructive gradientMap on a layer (adds it or updates it).
`adjust.grain`	`layer \| layers, amount, size, seed`	Non-destructive grain on a layer (adds it or updates it).
`adjust.hueSaturation`	`layer \| layers, hue, saturation, lightness, colorize`	Non-destructive hueSaturation on a layer (adds it or updates it).
`adjust.invert`	`layer \| layers, no settings`	Non-destructive invert on a layer (adds it or updates it).
`adjust.levels`	`layer \| layers, black, white, gamma, outputBlack, outputWhite`	Non-destructive levels on a layer (adds it or updates it).
`adjust.remove`	`layer \| layers, kind`	Remove one adjustment or filter from a layer.

फ़िल्टर

ऑपरेशन	पैरामीटर	यह क्या करता है
`filter.addNoise`	`layer \| layers, amount, gaussian, monochromatic, seed`	Non-destructive addNoise on a layer (adds it or updates it).
`filter.gaussianBlur`	`layer \| layers, radius`	Non-destructive gaussianBlur on a layer (adds it or updates it).
`filter.motionBlur`	`layer \| layers, angle, distance`	Non-destructive motionBlur on a layer (adds it or updates it).
`filter.pixelate`	`layer \| layers, size`	Non-destructive pixelate on a layer (adds it or updates it).
`filter.sharpen`	`layer \| layers, amount, radius, threshold`	Non-destructive sharpen on a layer (adds it or updates it).
`filter.vignette`	`layer \| layers, amount, midpoint, roundness, feather, color`	Non-destructive vignette on a layer (adds it or updates it).

एडजस्टमेंट लेयर्स

ऑपरेशन	पैरामीटर	यह क्या करता है
`adjustmentLayer.add`	`kind, settings…, name, above`	An adjustment layer: changes everything below it.
`adjustmentLayer.get`	`layer`	An adjustment layer's settings.
`adjustmentLayer.set`	`layer, settings…`	Change an adjustment layer (partial).

लेयर मास्क

ऑपरेशन	पैरामीटर	यह क्या करता है
`mask.add`	`layer, reveal \| hide \| rect \| ellipse (rect) \| gradient (from, to) \| asset_id (+ rect), feather, invert, cornerRadius`	Add or replace a layer mask.
`mask.blur`	`layer, radius`	Feather the layer mask.
`mask.delete`	`layer`	Remove the layer mask.
`mask.invert`	`layer`	Invert the layer mask.
`mask.setEnabled`	`layer, enabled`	Turn the layer mask on or off.

लेयर इफ़ेक्ट

ऑपरेशन	पैरामीटर	यह क्या करता है
`effects.copy`	`from, layer \| layers`	Copy effects from one layer to others.
`effects.get`	`layer`	A layer's effects.
`effects.remove`	`layer \| layers, kinds`	Remove effects (all, or the ones named).
`effects.set`	`layer \| layers, shadow {…}, stroke {…}, outerGlow {…}, colorOverlay {…}`	Set effects (partial): shadow, outerGlow, stroke, colorOverlay.
`effects.setEnabled`	`layer, kind, enabled`	Turn one effect on or off.

कैनवास

ऑपरेशन	पैरामीटर	यह क्या करता है
`canvas.crop`	`rect [x, y, width, height]`	Crop the canvas to a rectangle.
`canvas.imageSize`	`width and/or height, or percent`	Scale the whole document.
`canvas.setBackground`	`color`	Background colour, or null for transparent.
`canvas.size`	`width, height, anchor (topLeft…bottomRight, default center)`	Change the canvas without scaling layers.

प्रोजेक्ट

ऑपरेशन	पैरामीटर	यह क्या करता है
`project.state`	—	The whole document.

ब्लेंड मोड

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 तक।
मेगापिक्सेल, लेयर्स, प्रोजेक्ट, स्टोरेज और प्रति माह रेंडर प्लान पर निर्भर हैं: प्राइसिंग देखें।