Quickstart

Set up a tenant, activate billing, create an API key, then render the first PDF through /v1/pdf.

Endpoint
POST /v1/pdf
Returns application/pdf when rendering succeeds.
Tenant
tenant_...
Use tenant_... in the tenant header.
Authentication
Bearer API key
Create an active key from the API keys page before calling the API.

Headers

Header Value
X-RenderLayer-Tenant-Id tenant_...
Authorization Bearer <api-key-secret>
Content-Type application/json

Curl

curl --fail --location \
  --header "Content-Type: application/json" \
  --header "X-RenderLayer-Tenant-Id: tenant_..." \
  --header "Authorization: Bearer <api-key-secret>" \
  --output renderlayer-output.pdf \
  --data @payload.json \
  https://renderlayer.ynnova.ag/v1/pdf

Payload

{
  "html": "<!doctype html><html><body><h1>RenderLayer</h1></body></html>",
  "fileName": "renderlayer-output.pdf",
  "paper": {
    "format": "A4",
    "printBackground": true
  }
}

Errors

Status Code Meaning
400 invalid_request The request is missing required input, such as the html field.
401 missing_api_credentials The tenant id or API key header is missing.
401 invalid_api_key The API key does not match this tenant.
401 api_key_revoked The API key exists but has been revoked.
402 billing_subscription_inactive The paid subscription is not active or trialing.
413 payload_too_large The HTML payload exceeds the configured API limit.
429 monthly_render_limit_exceeded The tenant has used all renders available for the current month.
503 renderer_unavailable The rendering service is temporarily unavailable or not configured.
An unhandled error has occurred. Reload 🗙

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.