API Console

Use this page to run POST /api/v1/render requests directly from the documentation.

• pick a built-in example or paste your own JSON
• set your endpoint and Bearer token
• inspect PDF output, JSON errors, and response headers in one place

API Console

Postman-style runner for gPdf. Edit the request on the left and inspect PDF, error JSON, and headers on the right.

Preview PDF output, inspect error JSON, and check response headers.

Example

10-second startRecommended first production sampleImage asset shorthandImage explicit Base64 sourceBlock text

• 10-second startMinimal request to verify token, endpoint, and PDF bytes.
• Recommended first production sampleHeader, footer, image asset, barcode, and common text fields.
• Image asset shorthandTop-level asset + format form for object-storage images.
• Image explicit Base64 sourceExplicit source.kind = base64 form for inline payloads.
• Block textRecommended full text contract with frame/defaults/content.blocks.

Endpoint

Bearer Token

A Bearer token is required for direct API calls.

Request ID

Optional. Leave empty to let the service generate one.

Request BodyRequests are sent as POST with application/json.

{ "settings": { "defaults": { "text": { "font_family": "NotoSans-Regular", "font_size": 10.5, "color": "#111827" }, "stroke": { "color": "#111827", "width": 0.3 } }, "output": { "mode": "file", "file_name": "shipping-label.pdf" } }, "header": { "height": 10, "elements": [ { "type": "text", "x": 8, "y": 6, "content": "PDN EXPRESS" } ] }, "footer": { "height": 8, "elements": [ { "type": "text", "x": 8, "y": 4, "content": "Page ", "style": { "width": 30 } } ] }, "pages": [ { "size": "label_100_150", "elements": [ { "type": "image", "x": 8, "y": 12, "width": 18, "height": 8, "asset": "pdn_express_logo", "format": "jpg" }, { "type": "text", "x": 8, "y": 26, "content": "Order #SO-20260415-001", "style": { "font_size": 11, "font_weight": "bold" } }, { "type": "barcode", "x": 8, "y": 34, "width": 58, "height": 18, "format": "code128", "content": "SO-20260415-001", "barcode_text": { "enabled": true } }, { "type": "rect", "x": 8, "y": 56, "width": 84, "height": 28, "stroke": { "color": "#D1D5DB", "width": 0.3 } }, { "type": "text", "x": 12, "y": 62, "content": "Recipient: Alex Chen" }, { "type": "text", "x": 12, "y": 70, "content": "Address: 88 Harbor Road, Shanghai" } ] } ] }

Response

Run a request to preview the PDF here.