Paperwright.Sdk 0.1.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Paperwright.Sdk --version 0.1.0
                    


                    

                
NuGet\Install-Package Paperwright.Sdk -Version 0.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Paperwright.Sdk" Version="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Paperwright.Sdk" Version="0.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Paperwright.Sdk" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Paperwright.Sdk --version 0.1.0
                    


                    

                
#r "nuget: Paperwright.Sdk, 0.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Paperwright.Sdk@0.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Paperwright.Sdk&version=0.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Paperwright.Sdk&version=0.1.0
                    


                            Install as a Cake Tool

Paperwright.Sdk

Official .NET client for the Paperwright PDF rendering API. Render stored templates or inline content to PDF from your backend with an API key.

The API key is a server-side credential. Never embed it in browser or mobile clients — anyone who extracts it can render against your workspace.

Install

dotnet add package Paperwright.Sdk

Quick start

using Paperwright.Sdk;

var client = new PaperwrightClient("pdfly_your_key_here");

// Render a stored template by id
byte[] pdf = await client.RenderTemplateAsync(
    templateId: Guid.Parse("1d3a734b-0647-491a-9f79-359b0d83b2aa"),
    data: new { name = "Ali", total = 91.50m });

await File.WriteAllBytesAsync("invoice.pdf", pdf);

Inline rendering

Render the designer's JSON document directly, without storing it first:

byte[] pdf = await client.RenderInlineAsync(templateJson, new { name = "Ali" });

Registers PaperwrightClient as a typed HttpClient so it benefits from connection pooling and IHttpClientFactory lifetimes:

builder.Services.AddPaperwright(o =>
{
    o.ApiKey = builder.Configuration["Paperwright:ApiKey"]!;
    // o.BaseUrl = "http://localhost:5110"; // for local/self-hosted
});

// then inject PaperwrightClient anywhere
public class InvoiceService(PaperwrightClient pdfly) { /* ... */ }

Error handling

Non-success responses throw PaperwrightException with the HTTP StatusCode:

try
{
    var pdf = await client.RenderTemplateAsync(id, data);
}
catch (PaperwrightException ex) when (ex.StatusCode == HttpStatusCode.Unauthorized)
{
    // invalid or revoked API key
}

Configuration

Option Default Notes
ApiKey (required) The pdfly_… key from your dashboard
BaseUrl https://api.paperwright.dev Override for self-hosted/local
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.0 126 6/12/2026