ChartQuery

Label Preview

GET
/v1/label

Preview a thermal label via GET. Pass the same label object as a URL-encoded JSON string in query. Inside that JSON, text items use content and size (1-10), not text or fontSize. Prefer format=png for ChatGPT.

Credit cost: 3 credits per call

Query Parameters

format?string

Use png so ChatGPT can display the image. svg is for download or infinite scale.

Default"svg"
Value in"svg""png"
share?boolean

If true, persist the result and return share URLs instead of an image. Leave false to get the image.

Defaultfalse
query*string

Full label config as URL-encoded JSON. Must include width and elements. Text items use content and size (1-10), not text or fontSize.

fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse
width*number

Label width. Required. Default unit is mm. Example: 40. Do not send query instead of width.

height?number

Label height in the same unit. Example: 30. Omit for receipt / continuous mode.

unit?string

Measurement unit for width and height. Default mm. Use mm unless you are working in printer dots.

Default"mm"
Value in"mm""inch""dot"
dpi?number

Printer DPI. Default 203.

gap?number

Gap between labels in mm. Ignored for receipts.

speed?number

Print speed, 1-18.

density?number

Print darkness, 0-15.

direction?number

Print direction. 0 = normal, 1 = reversed.

Default1
Value in01
copies?number

Number of copies. Minimum 1.

printer?string

Printer profile id (tsc-te210, zebra-zd420, …).

elements*array<>

Required array. Text items need type=text, content, and size (1-10 magnification). Do not use text, fontSize, or type=barcode. Positions x/y are in dots. Example item: {"type":"text","content":"Order: 1042","x":10,"y":10,"size":2}.

Items1 <= items
language?string

Printer language for preview. Default tsc. Example: tsc or zpl.

Default"tsc"
Value in"tsc""zpl""epl""cpcl""dpl""sbpl""escpos""starprnt""ipl"

Response Body

Successful response

response?file
Formatbinary
Example Request
curl -X GET 'https://api.chartquery.com/v1/label?query=string&width=0&elements=%5Bobject+Object%5D'
Example Response
"string"