Skip to main content
POST
/
labels
/
render
Render ZPL label
curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/labels/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "zpl": "^XA^FO50,50^ADN,36,20^FDHello World^FS^XZ",
  "dpmm": "8dpmm",
  "width": 4,
  "height": 6,
  "format": "png"
}
'
"<string>"

Documentation Index

Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json
​
zpl
string
required

ZPL source code to render

​
dpmm
enum<string>
default:8dpmm

Dots per millimeter resolution

Available options:
6dpmm,
8dpmm,
12dpmm,
24dpmm
​
width
number
default:4

Label width in inches

Required range: 0.1 <= x <= 15
​
height
number
default:6

Label height in inches

Required range: 0.1 <= x <= 15
​
format
enum<string>
default:png

Output format

Available options:
png,
pdf
​
index
integer

Label index in ZPL (for multi-label ZPL)

Required range: x >= 0

Response

Rendered label image or PDF

The response is of type file.