Help Center
Skarn PDF
31 topics across 1 area — summaries, walkthroughs, and the data model behind them.
Featured concepts
ConceptDownloadLog — one row per document downloadA DownloadLog records each time a stored document is downloaded — a per-document audit trail.ConceptRenderLog — one row per render attemptA RenderLog records the outcome, timing, and size of every render call — the service's observability trail.ConceptStoredDocument — a persisted, downloadable PDFA StoredDocument is a rendered PDF the service kept on storage so it can be downloaded later by id.ConceptTenantFont — a tenant's uploaded brand fontA TenantFont is a custom font a tenant uploaded so its rendered PDFs use its own brand typeface.
All topics
General
- DownloadLog.documentIdThe StoredDocument that was downloaded.Element
- DownloadLog — one row per document downloadA DownloadLog records each time a stored document is downloaded — a per-document audit trail.Concept
- DownloadLog.requestIdCorrelates a download event to the originating request.Element
- DownloadLog.tenantIdThe tenant that performed a document download.Element
- DownloadLog.userAgentThe User-Agent of the client that downloaded the document.Element
- RenderLog.categoryA grouping label for a render, defaulting to "document".Element
- RenderLog.durationMsHow long a render took, in milliseconds — zero on failure.Element
- RenderLog.engineThe render engine that produced the document — currently always "pdf-lib".Element
- RenderLog.errorThe error message captured when a render failed, otherwise null.Element
- RenderLog — one row per render attemptA RenderLog records the outcome, timing, and size of every render call — the service's observability trail.Concept
- RenderLog.requestIdCorrelates a render log row back to the originating request.Element
- RenderLog.sizeBytesThe byte size of the rendered PDF — zero on failure.Element
- RenderLog.sourceThe originating label for a render, mirroring the request's category.Element
- RenderLog.successWhether the render succeeded or failed.Element
- RenderLog.tenantIdThe tenant whose render produced this log row.Element
- StoredDocument — a persisted, downloadable PDFA StoredDocument is a rendered PDF the service kept on storage so it can be downloaded later by id.Concept
- StoredDocument.categoryA grouping label for a StoredDocument, defaulting to "document".Element
- StoredDocument.expiresAtWhen a StoredDocument becomes eligible for automatic cleanup, or null to never expire.Element
- StoredDocument.filenameThe download filename for a StoredDocument, set from options.filename at render time.Element
- StoredDocument.metadataOptional caller-supplied JSON metadata stored alongside the document.Element
- StoredDocument.sizeBytesThe byte length of the rendered PDF stored for this document.Element
- StoredDocument.sourceThe originating label for a StoredDocument — used to filter and bulk-manage documents.Element
- StoredDocument.storagePathThe storage key where the rendered PDF bytes live.Element
- StoredDocument.tenantIdThe tenant that owns a StoredDocument — every read and delete is scoped to it.Element
- TenantFont — a tenant's uploaded brand fontA TenantFont is a custom font a tenant uploaded so its rendered PDFs use its own brand typeface.Concept
- TenantFont.familyThe font family name a tenant uploaded.Element
- TenantFont.sizeBytesThe byte size of an uploaded font file.Element
- TenantFont.storagePathThe storage key where an uploaded font file lives.Element
- TenantFont.tenantIdThe tenant that owns an uploaded brand font.Element
- TenantFont.uploadedAtWhen a tenant font was last uploaded or replaced.Element
- TenantFont.weightThe weight of an uploaded font — regular, medium, or bold.Element