Docs

Official SDKs

Use an official SDK when you want typed helpers, file encoding, job polling, and webhook verification without assembling HTTP yourself. REST remains the source of truth for field names. Agents should load RELAYPDF_API_KEY from the env file written by relaypdf setup — do not ask a human to paste a key.

Use an official SDK when you want typed helpers, file encoding, job polling, and webhook verification without assembling HTTP yourself. Core helpers cover: PDFs, images, templates, convert, PDF tools, barcodes, zip, jobs, files, account, and health.

FIVE LANGUAGES / ONE DOCUMENT API

Published packages for generation, native document processing, file handling, and billing controls. Choose your language to get started.

Node.js / TypeScript

v0.1.7

@relaypdf/sdk

npm install @relaypdf/sdk@0.1.7

Read the guide npm

Python

v0.1.6

relaypdf

pip install relaypdf==0.1.6

Read the guide PyPI

PHP

v0.1.2

relaypdf/relaypdf

composer require relaypdf/relaypdf:0.1.2

Read the guide Packagist

C# / .NET

v0.1.2

RelayPDF

dotnet add package RelayPDF --version 0.1.2

Read the guide NuGet

Java

v0.1.3

com.relaypdf:relaypdf

<dependency>
  <groupId>com.relaypdf</groupId>
  <artifactId>relaypdf</artifactId>
  <version>0.1.3</version>
</dependency>

Read the guide Maven Central

Packages

Node is TypeScript-first with zero runtime dependencies. Python is a small stdlib client. PHP uses ext-curl. C# targets net8.0. Java 17 uses HttpClient and Jackson. Package READMEs are the full client reference.

Default base URL is https://api.relaypdf.com. Pass baseUrl / base_url for local (http://localhost:8787).

Request JSON field names match REST exactly (html, printBackground, sourceFilename, callbackUrl). Method names are camelCase in Node, PHP, and Java; snake_case in Python; PascalCase in C#.

Language	Package	Install
Node.js / TypeScript	@relaypdf/sdk	npm install @relaypdf/sdk
Python	relaypdf	pip install relaypdf
PHP	relaypdf/relaypdf	composer require relaypdf/relaypdf
C# / .NET	RelayPDF	dotnet add package RelayPDF
Java	com.relaypdf:relaypdf	Maven com.relaypdf:relaypdf
CLI + MCP	@relaypdf/cli	npx @relaypdf/cli setup
n8n	n8n-nodes-relaypdf	Community Nodes → n8n-nodes-relaypdf

Document platform package versions

These published releases include native document processing, file upload/delete, billing usage and limits, and per-request retry/spending-cap options. Use the language guide for exact method names. Older installed packages may lack these helpers.

CLI + MCP: @relaypdf/cli 0.1.9. n8n: n8n-nodes-relaypdf 0.1.5; n8n Cloud verification remains separate from npm publication.

Language	Package	Release	Registry
Node.js / TypeScript	@relaypdf/sdk	0.1.7	npm
Python	relaypdf	0.1.6	PyPI
PHP	relaypdf/relaypdf	0.1.2	Packagist
C# / .NET	RelayPDF	0.1.2	NuGet
Java	com.relaypdf:relaypdf	0.1.3	Maven Central

Authentication

HTTP Bearer. Create a key in Dashboard → API keys or run npx @relaypdf/cli setup and approve in the browser. The SDK sends Authorization: Bearer <key>. Missing apiKey / api_key throws TypeError before any request. Not JWT.

Rate limiting

Trial wallets 20/min, funded or auto-reload 60/min, burst 5/10s. HTTP 429 includes Retry-After. Rate-limited calls are not billed.

Wallet millicents

1 millicent = $0.001. GET /v1/account wallet.balanceMillicents ÷ 1000 = dollars. $5.00 trial = 5000 millicents. $0.002 + 8× provider token cost plus rendering AI generate; see the accepted quote for exact microdollars. Failed jobs are never billed.

Get a key without pasting it

Do not ask a human to paste an API key into chat. Run the CLI device flow and approve in the browser.

CLI

npx @relaypdf/cli setup
# writes RELAYPDF_API_KEY to your env file with mode 0600

Response modes

Every generating method accepts response: "binary" | "url" | "async", same as REST.

• binary (default) — file bytes, plus save() / Save() helpers
• url — JSON with a public 24-hour download
• async — 202 job; poll jobs.wait / jobs.get or set callbackUrl

Surface map

Each helper is one HTTP call. The SDK does not retry failed requests.

SDK	REST
pdf.fromHtml / fromUrl / fromMarkdown / fromTemplate / create	POST /v1/pdf
templates.list / create / get / update / publish	GET/POST/PATCH /v1/templates
images.fromHtml / fromUrl	POST /v1/images
pdf.merge / extract / protect / bookmarks / raster / fromImages / stamp / rotate / deletePages / compress / info / text / unlock / formFields / formFill	POST /v1/pdf/*
barcodes.create / qr	POST /v1/barcodes
zip.create	POST /v1/zip
convert.create / fromHtml / fromPath / wkhtml	POST /v1/convert
jobs.get / jobs.wait	GET /v1/jobs/:id
files.upload / delete / download	POST /v1/files; DELETE/GET /v1/files/:id
process / ProcessAsync	Native document processing endpoints
billingUsage / billing_usage / BillingUsageAsync	GET /v1/billing/usage
billingLimits / billing_limits / BillingLimitsAsync	GET/PATCH /v1/billing/limits
account	GET /v1/account
health	GET /health
verifyWebhook / verify_webhook	RelayPDF-Signature

Document platform release support

The release adds ocr, pdfa, crop, resize, repair, optimize, attachments, extract-images, redact, compress, image-convert, and email processing. Every official SDK exposes process / ProcessAsync plus files.upload, files.delete, billingUsage / billing_usage, and billingLimits / billing_limits. Availability requires the matching released package. Older published versions may not contain these methods.

See /docs/files, /docs/billing, and each operation guide for field names and limits.

For safe retries, use URL or async output with Idempotency-Key. Per-request caps use X-RelayPDF-Max-Charge-Microdollars (integer millionths of USD). Billing APIs preserve microdollar precision; legacy account millicent fields are not the complete precise balance.

Docs hub →Node.js SDK →Playground →