Skip to content

API Reference

Base URL:

https://api.binderypress.dev

All requests must include your API key in the Authorization header:

Authorization: Bearer bp_sk_live_YOUR_KEY

See Authentication for details on key types and modes.

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

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.

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.
401 AUTH_REQUIRED Missing or invalid API key.
403 FORBIDDEN Key does not have access to the requested resource.
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 render quota exceeded.
500 STORED_TEMPLATE_INVALID A saved template failed schema v2 validation.
500 INTERNAL_ERROR Unexpected server error.
502 RENDER_ERROR Rendering failed.