SDKs & Libraries

npm install @copperline/rendex

import { Rendex } from "@copperline/rendex";
import { writeFile } from "node:fs/promises";

const rendex = new Rendex("YOUR_API_KEY");

// Capture screenshot (binary)
const { image, metadata } = await rendex.screenshot({
  url: "https://example.com",
  fullPage: true,
  format: "webp",
});
await writeFile("screenshot.webp", image);

// Capture screenshot (JSON with base64)
const json = await rendex.screenshotJson({ url: "https://example.com" });
console.log(json.data.bytesSize, json.meta.usage?.remaining);

// Generate signed GET URL (no network call)
const url = rendex.screenshotUrl({ url: "https://example.com" });
// Use in <img src={url}> — API key is in the URL, server-side only

import { Rendex } from "@copperline/rendex";
import { writeFile } from "node:fs/promises";

const rendex = new Rendex("YOUR_API_KEY");

// renderHtml() — raw HTML straight to an image, no URL needed
const { image } = await rendex.renderHtml(
  "<h1>Invoice #1234</h1>",
  { format: "pdf", width: 1200 },
);
await writeFile("invoice.pdf", image);

// renderHtmlJson() — same, but base64 JSON
const json = await rendex.renderHtmlJson("<h1>OG card</h1>", { width: 1200, height: 630 });
console.log(json.data.bytesSize);

// Or pass html directly to screenshot()
await rendex.screenshot({ html: "<h1>Hello</h1>", format: "png" });

import { Rendex } from "@copperline/rendex";
import { writeFile } from "node:fs/promises";

const rendex = new Rendex("YOUR_API_KEY");

// renderMarkdown() — Markdown to a styled image or PDF, no CSS needed.
// GitHub-flavored typography is applied server-side.
const { image } = await rendex.renderMarkdown(
  "# Weekly report\n\n- p95 down **12%**\n- 2 features shipped",
  { format: "pdf", pdfFormat: "A4", darkMode: true },
);
await writeFile("report.pdf", image);

// Or pass markdown directly to screenshot() / screenshotJson()
await rendex.screenshot({ markdown: "# Hello", format: "png" });

import { Rendex } from "@copperline/rendex";

const rendex = new Rendex("YOUR_API_KEY");

// Pass a `data` object to fill {{placeholders}} with logic-less Mustache.
// Works with html or markdown source (not url).
const { image } = await rendex.renderMarkdown(
  "# Invoice {{number}}\n\nBilled to **{{client}}**\n\nTotal: {{total}}",
  {
    data: { number: "INV-0042", client: "Northwind", total: "$57.00" },
    format: "pdf",
    pdfFormat: "A4",
  },
);

// Loops + nesting too: {{#items}}…{{/items}} and {{a.b}}.
// {{var}} is HTML-escaped; use {{{var}}} for trusted raw HTML.