API دستاویزات

Nordic Layers HTTPS پر https://app.layers.nordicbyte.co.uk کی 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`	آخری تبدیلی undo کریں
`POST`	`/v1/projects/{id}/redo`	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 تک۔
میگا پکسلز، لیئرز، پروجیکٹس، اسٹوریج اور ماہانہ رینڈرز پلان پر منحصر ہیں: قیمتیں دیکھیں۔