API Reference
Base URL:
https://api.binderypress.devAuthentication
Section titled “Authentication”All requests must include your API key in the Authorization header:
Authorization: Bearer bp_sk_live_YOUR_KEYSee Authentication for details on key types and modes.
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
POST |
/v1/render |
Render a template to PDF, PNG, ZPL, or HTML |
GET |
/v1/render-outputs/{id} |
Download a rendered output |
GET |
/v1/templates |
List published templates |
GET |
/v1/templates/{id}/content |
Get a template’s full content |
GET |
/v1/usage |
Check usage and quota |
GET |
/health |
Service health check |
Error Responses
Section titled “Error Responses”All errors follow a consistent format:
{ "error": "Template failed schema v2 validation", "code": "INVALID_TEMPLATE", "details": { "issues": [ { "path": "size.width", "message": "Invalid input: expected number, received string" } ] }}For template validation errors, details.issues contains objects with path and message fields.
Error Codes
Section titled “Error Codes”| Status | Code | Description |
|---|---|---|
400 |
BAD_REQUEST |
Invalid request body or parameters. |
400 |
V1_SCHEMA |
An inline template uses the legacy schema; schema v2 is required. |
400 |
INVALID_TEMPLATE |
An inline template failed schema v2 validation. details.issues contains specifics. |
400 |
DPI_OUT_OF_RANGE |
dpi is outside 50 to 600. See render limits. |
400 |
SIZE_OUT_OF_RANGE |
A template or media width or height is outside 1 to 1,500 mm. |
400 |
EXPRESSION_NOT_ALLOWED |
An expression uses a word expressions may not use; the error names it. See Words Expressions May Not Use. |
400 |
IMAGE_TOO_LARGE |
PNG or ZPL output would exceed 80 megapixels. |
400 |
INVALID_FORMAT |
The format is not supported, or data is a list and the format renders a single label. |
400 |
INVALID_SLOTS |
slots breaks a partial-sheet rule. |
400 |
BATCH_TOO_LARGE |
A batch holds more items than your plan renders in one request (Dev 10, Small 100; Big and Enterprise 250 for PDF and HTML, 100 for ZPL and PNG). |
400 |
INVALID_BATCH_ITEM |
An entry in a batch’s data list is not an object. |
400 |
INLINE_NOT_SUPPORTED |
A PNG batch asked for "delivery": "inline". |
400 |
INLINE_TOO_LARGE |
A batch’s ZPL or HTML is over 10 MB, too much to return inline. Not counted. |
401 |
AUTH_REQUIRED |
Missing or invalid API key. |
403 |
FORBIDDEN |
Key does not have access to the requested resource. |
403 |
DEMO_RESTRICTED |
A demo key asked for something other than a library template by its librarySlug:templateSlug. |
403 |
SUSPENDED |
The account is suspended. Contact support@edgecraftstudio.com. |
404 |
NOT_FOUND |
Resource not found or expired. |
413 |
PAYLOAD_TOO_LARGE |
Request body exceeds 10 MB (1 MB for demo keys). |
429 |
RATE_LIMITED |
Rate limit exceeded. Check Retry-After header. |
429 |
QUOTA_EXCEEDED |
Monthly renders used up (Dev at the quota, Small at 120% of it), or a batch has more items than renders left this month. |
500 |
STORED_TEMPLATE_INVALID |
A saved template failed schema v2 validation. |
500 |
INTERNAL_ERROR |
Unexpected server error. |
502 |
RENDER_ERROR |
Rendering failed. |
502 |
CONTAINER_ERROR |
No render container responded, even after one automatic retry on another container. Try again shortly. |
503 |
RATE_LIMITER_UNAVAILABLE |
Rate limiting is temporarily unavailable, so the request was not run. Retry after the Retry-After period. |
504 |
RENDER_TIMEOUT |
The render did not finish within 30 seconds (a batch: 60 seconds). |