{ "openapi": "3.1.0", "info": { "title": "pagenull API", "version": "1.0.0", "summary": "HTML or a URL to PDF or screenshot, with a signed receipt for every render.", "description": "Send HTML or a public URL, get a PDF or an image back in the same response. Every render carries an Ed25519-signed receipt (`pagenull-receipt`) over the SHA-256 of the exact output, and `pagenull-retention: none`: request content and output are not stored. Limits: html up to 5 MB, output up to 50 MB and 1000 pages, timeoutMs up to 60 s. Failed renders and test renders (`\"test\": true`) are free. Errors are always JSON: an unknown path answers 404 `not_found`, an unsupported method 405 `method_not_allowed` with an `Allow` header. Guides and examples: https://pagenull.dev/docs.", "termsOfService": "https://pagenull.dev/terms", "contact": { "name": "pagenull support", "email": "support@pagenull.dev", "url": "https://pagenull.dev/docs/api" }, "x-logo": { "url": "https://pagenull.dev/icon.svg", "altText": "pagenull" } }, "externalDocs": { "description": "API reference", "url": "https://pagenull.dev/docs/api" }, "servers": [ { "url": "https://api.pagenull.dev" } ], "security": [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ], "tags": [ { "name": "Render", "description": "HTML or URL to PDF or image." }, { "name": "Templates", "description": "Save a layout once, render it with JSON." }, { "name": "E-invoices", "description": "Factur-X / ZUGFeRD (EN 16931) from JSON." }, { "name": "Account", "description": "Usage and limits." }, { "name": "Receipts", "description": "Check a receipt. No key needed." } ], "paths": { "/v1/pdf": { "post": { "operationId": "createPdf", "tags": [ "Render" ], "summary": "Render HTML or a URL to PDF", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (1–255 visible ASCII characters), e.g. your order id. A retry with the same key and body within 24 hours is rendered again but not charged again.", "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PdfRequest" }, "example": { "html": "

Hello from pagenull

Rendered by headless Chromium.

", "format": "A4" } } } }, "responses": { "200": { "description": "The file itself. With `deliverTo`, the file goes to your storage instead and the answer is 201.", "headers": { "pagenull-retention": { "$ref": "#/components/headers/pagenull-retention" }, "pagenull-region": { "$ref": "#/components/headers/pagenull-region" }, "pagenull-render-id": { "$ref": "#/components/headers/pagenull-render-id" }, "pagenull-renderer": { "$ref": "#/components/headers/pagenull-renderer" }, "pagenull-receipt": { "$ref": "#/components/headers/pagenull-receipt" }, "pagenull-pages": { "$ref": "#/components/headers/pagenull-pages" }, "pagenull-warnings": { "$ref": "#/components/headers/pagenull-warnings" }, "x-render-ms": { "$ref": "#/components/headers/x-render-ms" }, "idempotent-replayed": { "$ref": "#/components/headers/idempotent-replayed" }, "x-quota-limit": { "$ref": "#/components/headers/x-quota-limit" }, "x-quota-used": { "$ref": "#/components/headers/x-quota-used" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-reset": { "$ref": "#/components/headers/x-ratelimit-reset" }, "content-disposition": { "$ref": "#/components/headers/content-disposition" } }, "content": { "application/pdf": { "schema": { "type": "string", "contentMediaType": "application/pdf" } } } }, "201": { "description": "With `deliverTo`: the file was uploaded to your storage. Nothing is kept here.", "headers": { "pagenull-retention": { "$ref": "#/components/headers/pagenull-retention" }, "pagenull-region": { "$ref": "#/components/headers/pagenull-region" }, "pagenull-render-id": { "$ref": "#/components/headers/pagenull-render-id" }, "pagenull-renderer": { "$ref": "#/components/headers/pagenull-renderer" }, "pagenull-receipt": { "$ref": "#/components/headers/pagenull-receipt" }, "pagenull-pages": { "$ref": "#/components/headers/pagenull-pages" }, "pagenull-warnings": { "$ref": "#/components/headers/pagenull-warnings" }, "x-render-ms": { "$ref": "#/components/headers/x-render-ms" }, "idempotent-replayed": { "$ref": "#/components/headers/idempotent-replayed" }, "x-quota-limit": { "$ref": "#/components/headers/x-quota-limit" }, "x-quota-used": { "$ref": "#/components/headers/x-quota-used" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-reset": { "$ref": "#/components/headers/x-ratelimit-reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Delivered" } } } }, "400": { "description": "`invalid_request`: The body isn't valid JSON or an option is wrong. The message names the field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "invalid_request" ] } } } } } } } }, "401": { "description": "`unauthorized`: Missing, unknown or revoked API key.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "unauthorized" ] } } } } } } } }, "409": { "description": "`idempotency_in_progress`: A request with the same Idempotency-Key is still running. Retry after Retry-After seconds.\n\n`idempotency_replay_limit`: This Idempotency-Key has been retried 5 times. Use a new key.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "idempotency_in_progress", "idempotency_replay_limit" ] } } } } } } } }, "413": { "description": "`payload_too_large`: Body larger than the limit, or html over 5 MB, or headerHtml/footerHtml over 64 KB.\n\n`output_too_large`: The output is over 50 MB or 1,000 pages.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "payload_too_large", "output_too_large" ] } } } } } } } }, "422": { "description": "`idempotency_mismatch`: The Idempotency-Key was already used for a different request.\n\n`blocked_url`: The URL, or a resource the page tried to load, points at a non-public address or a disallowed scheme. pagenull's own site (pagenull.dev and its subdomains) is refused too: send that page as html.\n\n`dns_failed`: url: the hostname doesn't resolve. Check the spelling, and that the domain is public.\n\n`url_unreachable`: url: the site couldn't be loaded. The message says why: connection refused or closed, no address that accepts a connection (including an attempt the network gave up on), invalid HTTPS certificate, more than 10 redirects, or a page over 20 MB.\n\n`url_http_error`: url: the site answered with an HTTP error (4xx or 5xx), so there was no page to render. The message has the status.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "idempotency_mismatch", "blocked_url", "dns_failed", "url_unreachable", "url_http_error" ] } } } } } } } }, "429": { "description": "`rate_limited`: Too many requests this minute, for this key or for the account. Wait for Retry-After seconds.\n\n`quota_exceeded`: Monthly renders used up. Resets on the 1st (UTC).", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "rate_limited", "quota_exceeded" ] } } } } } } } }, "500": { "description": "`internal_error`: Something broke on our side. Not charged. Retry, and quote pagenull-render-id if it keeps happening.\n\n`render_failed`: Chromium failed for a reason on our side (a page that can't be loaded has its own code above). Not charged. Retry, and write to support if it keeps happening.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "internal_error", "render_failed" ] } } } } } } } }, "502": { "description": "`delivery_failed`: deliverTo: your storage refused the upload, or couldn't be reached. The message has its status.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "delivery_failed" ] } } } } } } } }, "503": { "description": "`busy`: All renderers busy. Retry after Retry-After seconds.\n\n`renderer_unavailable`: The renderer restarted or couldn't be reached during the request. Not charged. Retry after Retry-After seconds.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "busy", "renderer_unavailable" ] } } } } } } } }, "504": { "description": "`url_timeout`: url: the site connected but didn't answer within timeoutMs (default 30 s), or the connection took that long. Safe to retry; a larger timeoutMs (up to 60 s) may help.\n\n`timeout`: The page didn't finish in timeoutMs, or waitFor never matched.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "url_timeout", "timeout" ] } } } } } } } } } } }, "/v1/screenshot": { "post": { "operationId": "createScreenshot", "tags": [ "Render" ], "summary": "Render HTML or a URL to PNG or JPEG", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (1–255 visible ASCII characters), e.g. your order id. A retry with the same key and body within 24 hours is rendered again but not charged again.", "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreenshotRequest" }, "example": { "url": "https://example.com", "width": 1280, "height": 800 } } } }, "responses": { "200": { "description": "The file itself. With `deliverTo`, the file goes to your storage instead and the answer is 201.", "headers": { "pagenull-retention": { "$ref": "#/components/headers/pagenull-retention" }, "pagenull-region": { "$ref": "#/components/headers/pagenull-region" }, "pagenull-render-id": { "$ref": "#/components/headers/pagenull-render-id" }, "pagenull-renderer": { "$ref": "#/components/headers/pagenull-renderer" }, "pagenull-receipt": { "$ref": "#/components/headers/pagenull-receipt" }, "pagenull-pages": { "$ref": "#/components/headers/pagenull-pages" }, "pagenull-warnings": { "$ref": "#/components/headers/pagenull-warnings" }, "x-render-ms": { "$ref": "#/components/headers/x-render-ms" }, "idempotent-replayed": { "$ref": "#/components/headers/idempotent-replayed" }, "x-quota-limit": { "$ref": "#/components/headers/x-quota-limit" }, "x-quota-used": { "$ref": "#/components/headers/x-quota-used" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-reset": { "$ref": "#/components/headers/x-ratelimit-reset" }, "content-disposition": { "$ref": "#/components/headers/content-disposition" } }, "content": { "image/png": { "schema": { "type": "string", "contentMediaType": "image/png" } }, "image/jpeg": { "schema": { "type": "string", "contentMediaType": "image/jpeg" } } } }, "201": { "description": "With `deliverTo`: the file was uploaded to your storage. Nothing is kept here.", "headers": { "pagenull-retention": { "$ref": "#/components/headers/pagenull-retention" }, "pagenull-region": { "$ref": "#/components/headers/pagenull-region" }, "pagenull-render-id": { "$ref": "#/components/headers/pagenull-render-id" }, "pagenull-renderer": { "$ref": "#/components/headers/pagenull-renderer" }, "pagenull-receipt": { "$ref": "#/components/headers/pagenull-receipt" }, "pagenull-pages": { "$ref": "#/components/headers/pagenull-pages" }, "pagenull-warnings": { "$ref": "#/components/headers/pagenull-warnings" }, "x-render-ms": { "$ref": "#/components/headers/x-render-ms" }, "idempotent-replayed": { "$ref": "#/components/headers/idempotent-replayed" }, "x-quota-limit": { "$ref": "#/components/headers/x-quota-limit" }, "x-quota-used": { "$ref": "#/components/headers/x-quota-used" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-reset": { "$ref": "#/components/headers/x-ratelimit-reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Delivered" } } } }, "400": { "description": "`invalid_request`: The body isn't valid JSON or an option is wrong. The message names the field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "invalid_request" ] } } } } } } } }, "401": { "description": "`unauthorized`: Missing, unknown or revoked API key.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "unauthorized" ] } } } } } } } }, "409": { "description": "`idempotency_in_progress`: A request with the same Idempotency-Key is still running. Retry after Retry-After seconds.\n\n`idempotency_replay_limit`: This Idempotency-Key has been retried 5 times. Use a new key.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "idempotency_in_progress", "idempotency_replay_limit" ] } } } } } } } }, "413": { "description": "`payload_too_large`: Body larger than the limit, or html over 5 MB, or headerHtml/footerHtml over 64 KB.\n\n`output_too_large`: The output is over 50 MB or 1,000 pages.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "payload_too_large", "output_too_large" ] } } } } } } } }, "422": { "description": "`idempotency_mismatch`: The Idempotency-Key was already used for a different request.\n\n`blocked_url`: The URL, or a resource the page tried to load, points at a non-public address or a disallowed scheme. pagenull's own site (pagenull.dev and its subdomains) is refused too: send that page as html.\n\n`dns_failed`: url: the hostname doesn't resolve. Check the spelling, and that the domain is public.\n\n`url_unreachable`: url: the site couldn't be loaded. The message says why: connection refused or closed, no address that accepts a connection (including an attempt the network gave up on), invalid HTTPS certificate, more than 10 redirects, or a page over 20 MB.\n\n`url_http_error`: url: the site answered with an HTTP error (4xx or 5xx), so there was no page to render. The message has the status.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "idempotency_mismatch", "blocked_url", "dns_failed", "url_unreachable", "url_http_error" ] } } } } } } } }, "429": { "description": "`rate_limited`: Too many requests this minute, for this key or for the account. Wait for Retry-After seconds.\n\n`quota_exceeded`: Monthly renders used up. Resets on the 1st (UTC).", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "rate_limited", "quota_exceeded" ] } } } } } } } }, "500": { "description": "`internal_error`: Something broke on our side. Not charged. Retry, and quote pagenull-render-id if it keeps happening.\n\n`render_failed`: Chromium failed for a reason on our side (a page that can't be loaded has its own code above). Not charged. Retry, and write to support if it keeps happening.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "internal_error", "render_failed" ] } } } } } } } }, "502": { "description": "`delivery_failed`: deliverTo: your storage refused the upload, or couldn't be reached. The message has its status.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "delivery_failed" ] } } } } } } } }, "503": { "description": "`busy`: All renderers busy. Retry after Retry-After seconds.\n\n`renderer_unavailable`: The renderer restarted or couldn't be reached during the request. Not charged. Retry after Retry-After seconds.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "busy", "renderer_unavailable" ] } } } } } } } }, "504": { "description": "`url_timeout`: url: the site connected but didn't answer within timeoutMs (default 30 s), or the connection took that long. Safe to retry; a larger timeoutMs (up to 60 s) may help.\n\n`timeout`: The page didn't finish in timeoutMs, or waitFor never matched.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "url_timeout", "timeout" ] } } } } } } } } } } }, "/v1/templates": { "get": { "operationId": "listTemplates", "tags": [ "Templates" ], "summary": "List your saved templates and the built-in ones", "responses": { "200": { "description": "Ids and names only.", "headers": { "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-reset": { "$ref": "#/components/headers/x-ratelimit-reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateList" } } } }, "401": { "description": "`unauthorized`: Missing, unknown or revoked API key.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "unauthorized" ] } } } } } } } }, "429": { "description": "`rate_limited`: Too many requests this minute, for this key or for the account. Wait for Retry-After seconds.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "rate_limited" ] } } } } } } } }, "500": { "description": "`internal_error`: Something broke on our side. Not charged. Retry, and quote pagenull-render-id if it keeps happening.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "internal_error" ] } } } } } } } } } }, "post": { "operationId": "createTemplate", "tags": [ "Templates" ], "summary": "Save a template", "description": "HTML and sample data are encrypted at rest. Mustache syntax: `{{x}}` is HTML-escaped, `{{{x}}}` is raw.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateCreate" }, "example": { "name": "Packing slip", "html": "

Order {{order}}

", "sampleData": { "order": "#1001", "lines": [ { "qty": 2, "name": "Notebook" } ] } } } } }, "responses": { "201": { "description": "Saved.", "headers": { "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-reset": { "$ref": "#/components/headers/x-ratelimit-reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateCreated" } } } }, "400": { "description": "`invalid_request`: The body isn't valid JSON or an option is wrong. The message names the field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "invalid_request" ] } } } } } } } }, "401": { "description": "`unauthorized`: Missing, unknown or revoked API key.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "unauthorized" ] } } } } } } } }, "403": { "description": "`forbidden`: Your plan doesn't include this (e.g. a saved-template limit).", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "forbidden" ] } } } } } } } }, "413": { "description": "`payload_too_large`: Body larger than the limit, or html over 5 MB, or headerHtml/footerHtml over 64 KB.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "payload_too_large" ] } } } } } } } }, "429": { "description": "`rate_limited`: Too many requests this minute, for this key or for the account. Wait for Retry-After seconds.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "rate_limited" ] } } } } } } } }, "500": { "description": "`internal_error`: Something broke on our side. Not charged. Retry, and quote pagenull-render-id if it keeps happening.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "internal_error" ] } } } } } } } } } } }, "/v1/templates/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A saved template id (`tpl_…`)." } ], "delete": { "operationId": "deleteTemplate", "tags": [ "Templates" ], "summary": "Delete a saved template", "description": "Only this key's account's templates. Built-in templates can't be deleted.", "responses": { "204": { "description": "Deleted.", "headers": { "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-reset": { "$ref": "#/components/headers/x-ratelimit-reset" } } }, "400": { "description": "`invalid_request`: The body isn't valid JSON or an option is wrong. The message names the field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "invalid_request" ] } } } } } } } }, "401": { "description": "`unauthorized`: Missing, unknown or revoked API key.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "unauthorized" ] } } } } } } } }, "404": { "description": "`not_found`: No such template on this account, or no such endpoint: every unknown /v1 path answers this, in JSON.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "not_found" ] } } } } } } } }, "429": { "description": "`rate_limited`: Too many requests this minute, for this key or for the account. Wait for Retry-After seconds.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "rate_limited" ] } } } } } } } }, "500": { "description": "`internal_error`: Something broke on our side. Not charged. Retry, and quote pagenull-render-id if it keeps happening.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "internal_error" ] } } } } } } } } } } }, "/v1/templates/{id}/render": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A saved template id, or a built-in one: `invoice`, `receipt`, `certificate`, `report`." } ], "post": { "operationId": "renderTemplate", "tags": [ "Templates" ], "summary": "Render a template with JSON data", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (1–255 visible ASCII characters), e.g. your order id. A retry with the same key and body within 24 hours is rendered again but not charged again.", "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateRenderRequest" }, "example": { "data": { "issuer": "Example Academy", "recipient": "Maria Ivanova", "course": "Practical TypeScript", "hours": 24, "date": "3 November 2026", "signatory": "Alex Example", "signatoryRole": "Course lead", "verifyId": "EXA-7Q2M-91KD" } } } } }, "responses": { "200": { "description": "The file itself. With `deliverTo`, the file goes to your storage instead and the answer is 201.", "headers": { "pagenull-retention": { "$ref": "#/components/headers/pagenull-retention" }, "pagenull-region": { "$ref": "#/components/headers/pagenull-region" }, "pagenull-render-id": { "$ref": "#/components/headers/pagenull-render-id" }, "pagenull-renderer": { "$ref": "#/components/headers/pagenull-renderer" }, "pagenull-receipt": { "$ref": "#/components/headers/pagenull-receipt" }, "pagenull-pages": { "$ref": "#/components/headers/pagenull-pages" }, "pagenull-warnings": { "$ref": "#/components/headers/pagenull-warnings" }, "x-render-ms": { "$ref": "#/components/headers/x-render-ms" }, "idempotent-replayed": { "$ref": "#/components/headers/idempotent-replayed" }, "x-quota-limit": { "$ref": "#/components/headers/x-quota-limit" }, "x-quota-used": { "$ref": "#/components/headers/x-quota-used" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-reset": { "$ref": "#/components/headers/x-ratelimit-reset" }, "content-disposition": { "$ref": "#/components/headers/content-disposition" } }, "content": { "application/pdf": { "schema": { "type": "string", "contentMediaType": "application/pdf" } } } }, "201": { "description": "With `deliverTo`: the file was uploaded to your storage. Nothing is kept here.", "headers": { "pagenull-retention": { "$ref": "#/components/headers/pagenull-retention" }, "pagenull-region": { "$ref": "#/components/headers/pagenull-region" }, "pagenull-render-id": { "$ref": "#/components/headers/pagenull-render-id" }, "pagenull-renderer": { "$ref": "#/components/headers/pagenull-renderer" }, "pagenull-receipt": { "$ref": "#/components/headers/pagenull-receipt" }, "pagenull-pages": { "$ref": "#/components/headers/pagenull-pages" }, "pagenull-warnings": { "$ref": "#/components/headers/pagenull-warnings" }, "x-render-ms": { "$ref": "#/components/headers/x-render-ms" }, "idempotent-replayed": { "$ref": "#/components/headers/idempotent-replayed" }, "x-quota-limit": { "$ref": "#/components/headers/x-quota-limit" }, "x-quota-used": { "$ref": "#/components/headers/x-quota-used" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-reset": { "$ref": "#/components/headers/x-ratelimit-reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Delivered" } } } }, "400": { "description": "`invalid_request`: The body isn't valid JSON or an option is wrong. The message names the field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "invalid_request" ] } } } } } } } }, "401": { "description": "`unauthorized`: Missing, unknown or revoked API key.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "unauthorized" ] } } } } } } } }, "404": { "description": "`not_found`: No such template on this account, or no such endpoint: every unknown /v1 path answers this, in JSON.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "not_found" ] } } } } } } } }, "409": { "description": "`idempotency_in_progress`: A request with the same Idempotency-Key is still running. Retry after Retry-After seconds.\n\n`idempotency_replay_limit`: This Idempotency-Key has been retried 5 times. Use a new key.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "idempotency_in_progress", "idempotency_replay_limit" ] } } } } } } } }, "413": { "description": "`payload_too_large`: Body larger than the limit, or html over 5 MB, or headerHtml/footerHtml over 64 KB.\n\n`output_too_large`: The output is over 50 MB or 1,000 pages.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "payload_too_large", "output_too_large" ] } } } } } } } }, "422": { "description": "`idempotency_mismatch`: The Idempotency-Key was already used for a different request.\n\n`blocked_url`: The URL, or a resource the page tried to load, points at a non-public address or a disallowed scheme. pagenull's own site (pagenull.dev and its subdomains) is refused too: send that page as html.\n\n`dns_failed`: url: the hostname doesn't resolve. Check the spelling, and that the domain is public.\n\n`url_unreachable`: url: the site couldn't be loaded. The message says why: connection refused or closed, no address that accepts a connection (including an attempt the network gave up on), invalid HTTPS certificate, more than 10 redirects, or a page over 20 MB.\n\n`url_http_error`: url: the site answered with an HTTP error (4xx or 5xx), so there was no page to render. The message has the status.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "idempotency_mismatch", "blocked_url", "dns_failed", "url_unreachable", "url_http_error" ] } } } } } } } }, "429": { "description": "`rate_limited`: Too many requests this minute, for this key or for the account. Wait for Retry-After seconds.\n\n`quota_exceeded`: Monthly renders used up. Resets on the 1st (UTC).", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "rate_limited", "quota_exceeded" ] } } } } } } } }, "500": { "description": "`internal_error`: Something broke on our side. Not charged. Retry, and quote pagenull-render-id if it keeps happening.\n\n`render_failed`: Chromium failed for a reason on our side (a page that can't be loaded has its own code above). Not charged. Retry, and write to support if it keeps happening.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "internal_error", "render_failed" ] } } } } } } } }, "502": { "description": "`delivery_failed`: deliverTo: your storage refused the upload, or couldn't be reached. The message has its status.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "delivery_failed" ] } } } } } } } }, "503": { "description": "`busy`: All renderers busy. Retry after Retry-After seconds.\n\n`renderer_unavailable`: The renderer restarted or couldn't be reached during the request. Not charged. Retry after Retry-After seconds.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "busy", "renderer_unavailable" ] } } } } } } } }, "504": { "description": "`url_timeout`: url: the site connected but didn't answer within timeoutMs (default 30 s), or the connection took that long. Safe to retry; a larger timeoutMs (up to 60 s) may help.\n\n`timeout`: The page didn't finish in timeoutMs, or waitFor never matched.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "url_timeout", "timeout" ] } } } } } } } } } } }, "/v1/invoices": { "post": { "operationId": "createInvoice", "tags": [ "E-invoices" ], "summary": "Create a Factur-X / ZUGFeRD e-invoice (PDF/A-3b with the EN 16931 XML embedded)", "description": "Send real numbers (quantities, net unit prices, VAT rates). Lines, the VAT breakdown and totals are calculated with exact decimal arithmetic, so the printed page and the XML agree.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (1–255 visible ASCII characters), e.g. your order id. A retry with the same key and body within 24 hours is rendered again but not charged again.", "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRequest" }, "example": { "invoice": { "number": "INV-2026-0142", "issueDate": "2026-11-03", "dueDate": "2026-11-17", "seller": { "name": "Northwind Studio EOOD", "address": { "line1": "12 Example Street", "city": "Sofia", "postcode": "1000", "country": "BG" }, "vatId": "BG123456789" }, "buyer": { "name": "Acme Robotics GmbH", "address": { "line1": "Musterstraße 1", "city": "Berlin", "postcode": "10115", "country": "DE" }, "vatId": "DE123456789" }, "lines": [ { "description": "API integration, October", "quantity": 12, "unit": "HUR", "unitPrice": "85.00", "vatCategory": "AE", "vatRate": 0 } ], "payment": { "iban": "BG80BNBG96611020345678" } }, "profile": "EN16931" } } } }, "responses": { "200": { "description": "The file itself. With `deliverTo`, the file goes to your storage instead and the answer is 201.", "headers": { "pagenull-retention": { "$ref": "#/components/headers/pagenull-retention" }, "pagenull-region": { "$ref": "#/components/headers/pagenull-region" }, "pagenull-render-id": { "$ref": "#/components/headers/pagenull-render-id" }, "pagenull-renderer": { "$ref": "#/components/headers/pagenull-renderer" }, "pagenull-receipt": { "$ref": "#/components/headers/pagenull-receipt" }, "pagenull-pages": { "$ref": "#/components/headers/pagenull-pages" }, "pagenull-warnings": { "$ref": "#/components/headers/pagenull-warnings" }, "x-render-ms": { "$ref": "#/components/headers/x-render-ms" }, "idempotent-replayed": { "$ref": "#/components/headers/idempotent-replayed" }, "x-quota-limit": { "$ref": "#/components/headers/x-quota-limit" }, "x-quota-used": { "$ref": "#/components/headers/x-quota-used" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-reset": { "$ref": "#/components/headers/x-ratelimit-reset" }, "content-disposition": { "$ref": "#/components/headers/content-disposition" }, "pagenull-einvoice": { "$ref": "#/components/headers/pagenull-einvoice" } }, "content": { "application/pdf": { "schema": { "type": "string", "contentMediaType": "application/pdf" } } } }, "201": { "description": "With `deliverTo`: the file was uploaded to your storage. Nothing is kept here.", "headers": { "pagenull-retention": { "$ref": "#/components/headers/pagenull-retention" }, "pagenull-region": { "$ref": "#/components/headers/pagenull-region" }, "pagenull-render-id": { "$ref": "#/components/headers/pagenull-render-id" }, "pagenull-renderer": { "$ref": "#/components/headers/pagenull-renderer" }, "pagenull-receipt": { "$ref": "#/components/headers/pagenull-receipt" }, "pagenull-pages": { "$ref": "#/components/headers/pagenull-pages" }, "pagenull-warnings": { "$ref": "#/components/headers/pagenull-warnings" }, "x-render-ms": { "$ref": "#/components/headers/x-render-ms" }, "idempotent-replayed": { "$ref": "#/components/headers/idempotent-replayed" }, "x-quota-limit": { "$ref": "#/components/headers/x-quota-limit" }, "x-quota-used": { "$ref": "#/components/headers/x-quota-used" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-reset": { "$ref": "#/components/headers/x-ratelimit-reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Delivered" } } } }, "400": { "description": "`invalid_request`: The body isn't valid JSON or an option is wrong. The message names the field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "invalid_request" ] } } } } } } } }, "401": { "description": "`unauthorized`: Missing, unknown or revoked API key.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "unauthorized" ] } } } } } } } }, "404": { "description": "`not_found`: No such template on this account, or no such endpoint: every unknown /v1 path answers this, in JSON.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "not_found" ] } } } } } } } }, "409": { "description": "`idempotency_in_progress`: A request with the same Idempotency-Key is still running. Retry after Retry-After seconds.\n\n`idempotency_replay_limit`: This Idempotency-Key has been retried 5 times. Use a new key.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "idempotency_in_progress", "idempotency_replay_limit" ] } } } } } } } }, "413": { "description": "`payload_too_large`: Body larger than the limit, or html over 5 MB, or headerHtml/footerHtml over 64 KB.\n\n`output_too_large`: The output is over 50 MB or 1,000 pages.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "payload_too_large", "output_too_large" ] } } } } } } } }, "422": { "description": "`idempotency_mismatch`: The Idempotency-Key was already used for a different request.\n\n`blocked_url`: The URL, or a resource the page tried to load, points at a non-public address or a disallowed scheme. pagenull's own site (pagenull.dev and its subdomains) is refused too: send that page as html.\n\n`dns_failed`: url: the hostname doesn't resolve. Check the spelling, and that the domain is public.\n\n`url_unreachable`: url: the site couldn't be loaded. The message says why: connection refused or closed, no address that accepts a connection (including an attempt the network gave up on), invalid HTTPS certificate, more than 10 redirects, or a page over 20 MB.\n\n`url_http_error`: url: the site answered with an HTTP error (4xx or 5xx), so there was no page to render. The message has the status.\n\n`invalid_invoice`: /v1/invoices: the invoice breaks an EN 16931 rule (e.g. reverse charge without the buyer's VAT number). The message names the field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "idempotency_mismatch", "blocked_url", "dns_failed", "url_unreachable", "url_http_error", "invalid_invoice" ] } } } } } } } }, "429": { "description": "`rate_limited`: Too many requests this minute, for this key or for the account. Wait for Retry-After seconds.\n\n`quota_exceeded`: Monthly renders used up. Resets on the 1st (UTC).", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "rate_limited", "quota_exceeded" ] } } } } } } } }, "500": { "description": "`internal_error`: Something broke on our side. Not charged. Retry, and quote pagenull-render-id if it keeps happening.\n\n`render_failed`: Chromium failed for a reason on our side (a page that can't be loaded has its own code above). Not charged. Retry, and write to support if it keeps happening.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "internal_error", "render_failed" ] } } } } } } } }, "502": { "description": "`delivery_failed`: deliverTo: your storage refused the upload, or couldn't be reached. The message has its status.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "delivery_failed" ] } } } } } } } }, "503": { "description": "`busy`: All renderers busy. Retry after Retry-After seconds.\n\n`renderer_unavailable`: The renderer restarted or couldn't be reached during the request. Not charged. Retry after Retry-After seconds.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "busy", "renderer_unavailable" ] } } } } } } } }, "504": { "description": "`url_timeout`: url: the site connected but didn't answer within timeoutMs (default 30 s), or the connection took that long. Safe to retry; a larger timeoutMs (up to 60 s) may help.\n\n`timeout`: The page didn't finish in timeoutMs, or waitFor never matched.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "url_timeout", "timeout" ] } } } } } } } } } } }, "/v1/usage": { "get": { "operationId": "getUsage", "tags": [ "Account" ], "summary": "This month's usage and limits", "responses": { "200": { "description": "Usage for the current month (UTC).", "headers": { "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-reset": { "$ref": "#/components/headers/x-ratelimit-reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Usage" } } } }, "401": { "description": "`unauthorized`: Missing, unknown or revoked API key.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "unauthorized" ] } } } } } } } }, "429": { "description": "`rate_limited`: Too many requests this minute, for this key or for the account. Wait for Retry-After seconds.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "rate_limited" ] } } } } } } } }, "500": { "description": "`internal_error`: Something broke on our side. Not charged. Retry, and quote pagenull-render-id if it keeps happening.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "internal_error" ] } } } } } } } } } } }, "/api/receipts/verify": { "servers": [ { "url": "https://pagenull.dev" } ], "post": { "operationId": "verifyReceipt", "tags": [ "Receipts" ], "summary": "Check a receipt's signature, and optionally a file's SHA-256", "description": "Send only the receipt and the hash; the file never needs to leave your machine. Nothing is stored. Limited to 30 checks a minute per address.", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyRequest" } } } }, "responses": { "200": { "description": "The result. An invalid receipt is still a 200, with `valid: false` and a reason.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyResult" } } } }, "400": { "description": "`invalid_request`: The body isn't valid JSON or an option is wrong. The message names the field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "invalid_request" ] } } } } } } } }, "413": { "description": "`payload_too_large`: Body larger than the limit, or html over 5 MB, or headerHtml/footerHtml over 64 KB.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "payload_too_large" ] } } } } } } } }, "429": { "description": "`rate_limited`: Too many requests this minute, for this key or for the account. Wait for Retry-After seconds.", "headers": { "retry-after": { "$ref": "#/components/headers/retry-after" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "properties": { "error": { "properties": { "code": { "type": "string", "enum": [ "rate_limited" ] } } } } } } } } } } }, "/.well-known/pagenull-keys.json": { "get": { "operationId": "getReceiptKeys", "tags": [ "Receipts" ], "summary": "The public keys receipts are signed with (JWK set)", "security": [], "responses": { "200": { "description": "Ed25519 public keys.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Jwks" } } } } } } }, "/health": { "get": { "operationId": "getHealth", "tags": [ "Account" ], "summary": "Service health", "security": [], "responses": { "200": { "description": "Database and renderer reachable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Health" } } } }, "503": { "description": "Something is down.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Health" } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Your API key: `Authorization: Bearer pm_live_…`." }, "apiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-Key", "description": "The same key in an `X-API-Key` header instead." } }, "headers": { "pagenull-retention": { "description": "Always `none`: nothing from the request or its output was stored.", "schema": { "type": "string", "enum": [ "none" ] } }, "pagenull-region": { "description": "Where the render ran, e.g. `hetzner-helsinki`. Also signed into the receipt.", "schema": { "type": "string" } }, "pagenull-render-id": { "description": "The id of this render. It's what we log; quote it to support.", "schema": { "type": "string", "format": "uuid" } }, "pagenull-renderer": { "description": "The renderer build: a SHA-256 of the renderer's code, dependency versions and Chromium version.", "schema": { "type": "string" } }, "pagenull-receipt": { "description": "Ed25519-signed receipt over the render id, the SHA-256 of the output, the time, the region, the renderer build and `stored: false`. Check it at https://pagenull.dev/verify or with the key at /.well-known/pagenull-keys.json.", "schema": { "type": "string", "pattern": "^v1\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+$" } }, "pagenull-pages": { "description": "Pages in the output (1 for screenshots).", "schema": { "type": "string", "pattern": "^[0-9]+$" } }, "pagenull-warnings": { "description": "Only present when something looked wrong; comma-separated. The render still succeeded. The values:\n\n- `missing_glyphs: