Node.js SDK

npm install @relaypdf/sdk

import { RelayPDF } from "@relaypdf/sdk";

const client = new RelayPDF({
  apiKey: process.env.RELAYPDF_API_KEY!,
});

const pdf = await client.pdf.fromHtml(
  "<h1>Invoice #1042</h1><p>Total: $1,200.00</p>",
  { filename: "invoice.pdf" },
);

await pdf.save("invoice.pdf");
console.log(pdf.id, pdf.sizeBytes, pdf.contentType);

const pdf = await client.pdf.fromUrl("https://example.com", {
  filename: "page.pdf",
  options: {
    format: "A4",
    printBackground: true,
    waitUntil: "networkidle0",
  },
});
await pdf.save("page.pdf");

const pdf = await client.pdf.fromHtml("<h1>Hello from RelayPDF</h1>", {
  options: { format: "letter" },
});
await pdf.save("hello.pdf");

const pdf = await client.pdf.fromHtml("<h1>Invoice</h1>", {
  options: {
    headerTemplate:
      '<div style="font-size:9px;width:100%;text-align:center;">Invoice</div>',
    footerTemplate:
      '<div style="font-size:9px;width:100%;text-align:center;">Page <span class="pageNumber"></span> of <span class="totalPages"></span></div>',
    margin: { top: "20mm", bottom: "20mm" },
  },
});

const md = await client.pdf.fromMarkdown("# Hello\n\nFrom **Markdown**.");

const invoice = await client.pdf.fromTemplate(
  "invoice",
  { number: "INV-1042", total: 1458 },
  { filename: "invoice.pdf", strict: true },
);

const pdf = await client.pdf.fromUrl("https://example.com");
if (pdf.kind === "binary") {
  console.log(pdf.id);
  console.log(pdf.filename);
  console.log(pdf.sizeBytes);
  console.log(pdf.contentType);
  console.log(pdf.bytes.byteLength);
  await pdf.save("example.pdf");
}

const result = await client.pdf.fromHtml("<h1>Invoice</h1>", {
  response: "url",
  filename: "invoice.pdf",
});
if (result.kind === "url") {
  console.log(result.url);
  console.log(result.expiresAt);
  console.log(result.sizeBytes);
}

const job = await client.convert.fromPath("./deck.pptx", {
  to: "pdf",
  response: "async",
});
if (job.kind === "async") {
  const done = await client.jobs.wait(job.id, {
    intervalMs: 1500,
    timeoutMs: 120_000,
  });
  const file = await client.files.download(done.id);
  await file.save("deck.pdf");
}

const shot = await client.images.fromUrl("https://example.com", {
  options: { fullPage: true, type: "png" },
});

const fromWord = await client.convert.fromPath("./letter.docx", { to: "pdf" });
const docx = await client.convert.fromHtml("<h1>Report</h1>", { to: "docx" });

const pack = await client.pdf.merge({
  files: [
    { url: "https://example.com/cover.pdf" },
    { file: fromWord.kind === "binary" ? fromWord.bytes : new Uint8Array() },
  ],
});

const qr = await client.barcodes.qr("https://relaypdf.com");

const live = await client.health();
console.log(live.ok, live.service);

const account = await client.account();
console.log(account.plan, account.rateTier, account.wallet.balanceMillicents);

import { verifyWebhook, WEBHOOK_SIGNATURE_HEADER } from "@relaypdf/sdk";

const ok = await verifyWebhook(
  process.env.RELAYPDF_WEBHOOK_SECRET!,
  rawBody,
  request.headers.get(WEBHOOK_SIGNATURE_HEADER) ?? "",
);
if (!ok) return new Response("invalid signature", { status: 400 });

import { RelayPDF, RelayPDFError } from "@relaypdf/sdk";

try {
  await client.pdf.fromUrl("https://example.com");
} catch (error) {
  if (error instanceof RelayPDFError) {
    console.log(error.status);
    console.log(error.code);
    console.log(error.message);
    console.log(error.retryAfter);
    if (error.code === "payment_required") {
      // top up the wallet
    }
    if (error.code === "rate_limited") {
      console.log("Retry-After", error.retryAfter);
    }
  } else {
    throw error;
  }
}

const client = new RelayPDF({
  apiKey: process.env.RELAYPDF_API_KEY!,
  baseUrl: "http://localhost:8787",
  fetch: globalThis.fetch,
});