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 వరకు.
మెగాపిక్సెల్స్, లేయర్లు, ప్రాజెక్ట్‌లు, స్టోరేజ్, నెలవారీ రెండర్‌లు ప్లాన్‌పై ఆధారపడతాయి: ధరలు చూడండి.