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.

MethodPathDescription
POST/v1/renderRender a template to PDF, PNG, ZPL, or HTML
GET/v1/render-outputs/{id}Download a rendered output
GET/v1/templatesList published templates
GET/v1/templates/{id}/contentGet a template’s full content
GET/v1/usageCheck usage and quota
GET/healthService health check

All errors follow a consistent format:

{
"error": "Human-readable error message",
"code": "MACHINE_READABLE_CODE",
"details": {}
}
StatusCodeDescription
400BAD_REQUESTInvalid request body or parameters.
400INVALID_TEMPLATETemplate validation failed. details.errors contains specifics.
401AUTH_REQUIREDMissing or invalid API key.
403FORBIDDENKey does not have access to the requested resource.
404NOT_FOUNDResource not found or expired.
413PAYLOAD_TOO_LARGERequest body exceeds 1 MB.
429RATE_LIMITEDRate limit exceeded. Check Retry-After header.
429QUOTA_EXCEEDEDMonthly render quota exceeded.
500INTERNAL_ERRORUnexpected server error.
502RENDER_ERRORThe render container encountered an error.