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" दिल्यास इमेजच.

पहिली रिक्वेस्ट

ग्रेडियंट आणि शीर्षकासह १०८०×१०८० प्रोजेक्ट तयार करा, मग तो 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 पर्यंत.
मेगापिक्सेल, लेयर्स, प्रोजेक्ट, स्टोरेज आणि दरमहा रेंडर प्लॅनवर अवलंबून आहेत: किंमत पाहा.