Striped API Reference

Programmatic ZPL rendering, label retrieval, and template merging

v1REST API|JSON responses|Bearer auth

Introduction

The Striped API lets you programmatically render ZPL code to images, retrieve stored label templates, and perform variable substitution for dynamic label generation. It's designed for integrating thermal label printing into your applications, scripts, and workflows.

Render ZPL

Convert raw ZPL code to PNG images via a single API call

Fetch Labels

Retrieve stored labels with version selection and template merging

Multi-Format

Get output as ZPL source, PNG image, or PDF document

Base URL

https://your-domain.com/api/v1

All API endpoints are prefixed with /api/v1. Replace your-domain.com with your actual deployment URL.

Quick Start

Get your first label rendered in under a minute:

1

Create an API token

Go to Settings and create an API token in the API Tokens section.

2

Make your first request

Send ZPL to the render endpoint and get back a base64 PNG:

cURLbash
curl -X POST https://your-domain.com/api/v1/render \
  -H "Authorization: Bearer sk_live_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "zpl": "^XA^FO50,50^A0N,50,50^FDHello World^FS^XZ",
    "width": 4,
    "height": 6,
    "dpi": 203
  }'
3

Use the response

The response contains a base64-encoded PNG image. Decode it to display, save, or send to a printer.

Credits

API calls consume credits from your account balance. Credits are only deducted on successful responses (HTTP 2xx). Failed requests are never charged.

EndpointCredits per Call
POST /api/v1/render1 credit
GET /api/v1/labels/[id]/render1 credit