PDF (totalum-sdk/pdf)

import … from 'totalum-sdk/pdf' — or the same namespace on totalum from 'totalum-sdk'. Install, configuration and errors: Totalum SDK.

Turn HTML or a web page into a PDF stored in the project's files: invoices, tickets, reports. Each call returns the stored file's key and url, plus what it cost in usage.credits.

const pdf = await totalum.pdf.fromHtml({ html: '<h1>Invoice 12</h1>', name: 'invoice-12' });

#totalumPdf

totalumPdf(options?: TotalumClientOptions): TotalumPdf

Creates the pdf namespace (the same object as totalum.pdf, scope files:write): each call renders a PDF and stores it as a new public file of the project.

Parameters

Returns TotalumPdf — The pdf namespace: the methods below.

Example

import { totalumPdf } from 'totalum-sdk/pdf';

const pdf = totalumPdf();
const invoice = await pdf.fromHtml({ html: '<h1>Invoice 12</h1>', name: 'invoice-12' });

The namespace's type is exported as TotalumPdf (import type { TotalumPdf } from 'totalum-sdk/pdf').

#pdf.fromHtml

pdf.fromHtml(input: PdfFromHtmlInput): Promise<{ key, fileName, url, usage }>

Renders HTML (with its CSS) to a PDF in a real browser and stores it as a project file: invoices, tickets, certificates, reports. Use inline <style> and absolute image URLs. Every call stores a new file, even with the same name.

Parameters

Returns Promise<{ key, fileName, url, usage }> — The stored PDF's key, url and fileName, and the credits it cost.

Errors — besides the errors every call can throw:

Example

const pdf = await totalum.pdf.fromHtml({
  html: '<style>body{font-family:sans-serif}</style><h1>Invoice 12</h1><p>Total: 49.00 €</p>',
  name: 'invoice-12',
  options: { format: 'A4', printBackground: true, margin: { top: '20mm', bottom: '20mm' } },
});

Result:

{
  "url": "https://files.totalum-project.com/p/acme-crm/01M4P0S5Q26K57B47C6E9A65Y5.pdf",
  "fileName": "invoice-12.pdf",
  "key": "p/acme-crm/01M4P0S5Q26K57B47C6E9A65Y5.pdf",
  "usage": { "credits": 0.0004 }
}

#pdf.fromUrl

pdf.fromUrl(input: PdfFromUrlInput): Promise<{ key, fileName, url, usage }>

Prints a web page to a PDF and stores it as a project file — archive a page, or render one of your own pages (a printable report route) as a PDF.

Parameters

Returns Promise<{ key, fileName, url, usage }> — The stored PDF's key, url and fileName, and the credits it cost.

Errors — besides the errors every call can throw:

Example

const pdf = await totalum.pdf.fromUrl({
  url: 'https://acme.totalum.app/reports/2026-09/print',
  name: 'report-2026-09',
  options: { format: 'A4', landscape: true },
});

Result:

{
  "url": "https://files.totalum-project.com/p/acme-crm/01M4P1D2E3F4G5H6J7K8M9N0PQ.pdf",
  "fileName": "report-2026-09.pdf",
  "key": "p/acme-crm/01M4P1D2E3F4G5H6J7K8M9N0PQ.pdf",
  "usage": { "credits": 0.0006 }
}

#PdfFromHtmlInput

The input of pdf.fromHtml().

#PdfFromUrlInput

The input of pdf.fromUrl().

#PdfOutput

A PDF stored as a public project file, from totalum.pdf.