The Apryse Server SDK is cross-platform and supported on Windows, Linux, and macOS. The base package is robust, allowing you to programmatically do the following with PDFs:
Additional functionality
If you’re looking for additional capabilities, we offer add-on packages, such as Smart Data Extraction, and add-on modules, such as Office Conversion. For a complete list of add-ons, refer to the following:
Solutions and benefits
Using the Server SDK allows you to build server-side document processing solutions at scale without relying on client devices or cloud APIs. Since the Server runs entirely on-premises (or in your private cloud), you can ensure security and compliance with full control over access, storage, and encryption. You can also easily integrate with web apps, backend systems, document management systems, and content workflows.
Steps & samples
The Apryse .NET get started guide explains how to install and use the Apryse Server SDK in a .NET application. It includes the full .NET PDF library and sample modules. This guide focuses on the OfficeToPDFTest sample to convert Office documents to PDF and demonstrates how to build a simple app for programmatic PDF generation.
Get started video
Get started with the Apryse Server SDK on Windows using the following video. You can skip the video and follow the step-by-step instructions to get started.
Get started video for Apryse Server SDK on the Windows platform
To get started, choose your preferred platform from the following tabs.
You'll get started with our samples to see the output you can create when you integrate the Apryse Server SDK into your application. You'll also create a project and integrate the Server SDK into your application, using the Windows platform.
Before you start:
Apryse collects some data regarding your usage of the SDK for product improvement.
If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.
A commercial license key is required for use in a production environment. Contact sales by filling out our licensing form if you want to purchase a commercial license key.
License keys are uniquely generated and strictly confidential. Don't publish or store them in any public location, including public GitHub repositories.
In this section, you can download and run the OfficeToPDFTest PDFNet sample module, which demonstrates the SDK's document-conversion capabilities. Upon successful completion, you can convert a DOCX document to a PDF file while leveraging the MS Office-to-PDF conversion API. You can use this module as a reference implementation when integrating similar document-conversion functionality into your own applications. By running the sample, you can quickly:
PDFNetC64.zip file to the following location (replace YourName with your user name) or another location, if you prefer: C:\Users\YourName\PDFNetC64\Samples\ LicenseKey.cs file. Open Visual Studio Code, select File > Open File, and navigate to: C:\Users\YourName\PDFNetC64\Samples\LicenseKey\CS. Click on the LicenseKey.cs file and click Open.private static string key = “YOUR_PDFTRON_LICENSE_KEY”; and replace the words in quotes with the copy of your trial license key you generated when you completed the Prerequisites instructions above. Do not change any other information in this file.
Add your trial license key.
5. Save your changes and close the file.
6. Open the Windows PowerShell and navigate to the CS folder as follows, replacing YourName with your user name, then press Enter:
You will see:

Open Windows PowerShell and navigate to the OfficeToPDFTest\CS folder.
7. From the project directory, on the command line, enter the following, then press Enter.
When you run the ./RunTest.bat command, the sample code loads an Office document, converts the Office document to PDF, saves the resulting PDF, and outputs status messages to the console. For more details, you can look at additional OfficeToPDF sample code and the Convert MS Office (Word, Excel, PowerPoint) to PDF overview.

You will see PDFNet is running in demo mode.
8. Navigate to: C:\Users\YourName\PDFNetC64\Samples\TestFiles\Output. You will see three output PDF files (Fishermen.pdf, the_rime_of_the_ancient_mariner.pdf, and the factsheet_Arabic.pdf):

Go to the Windows file explorer and navigate to the new PDF files you just converted.
9. Open the PDF files to see the converted output. You have successfully run the OfficeToPDFTest conversion sample!

Open the PDF files to see the converted output.
This section provides steps to create a simple .NET project that uses the Apryse SDK and the PDFNet library to programmatically generate a blank PDF document. With these steps, you can learn how to set up your environment, import the required libraries, and run a script that produces a valid PDF file—all without manual intervention. This example provides a practical foundation for more advanced document‑generation workflows.

Create a new project in Visual Studio.
3. In the Project name field, enter a name for your project.
4. Under Location, enter the file location where you want the project to be created, then click Next.

Add a project name and location where you want the project to be saved.
Note the file location of the project you just entered - you will need it later in section 3. Integrate the Apryse Server SDK into your application below.
5. In the Framework drop-down menu, click on the version you want to use (for example .NET 8), then click Create.

Choose the version of the .NET Framework you will be using.
A default app scaffolds where you can run and debug it.

Your default app is created so you can run and debug your project.

Access the NuGet Package Manager.
2. Under the Browse tab, in the Search field, enter Apryse, then click Enter. This will show you the various libraries that Apryse has published.

Search for the libraries that Apryse has published.
3. In the search results, select PDFTron.NET.x64.
4. In the Versions pane, select Project and GetStarted_DotNET, then click Install.

Select the GetStarted_DotNET project to install.
5. In the Preview Changes dialog, click Apply to add it to your project.

When you click Apply the changes will be made to your solution.
6. Once it’s been added, in the Output pane, you will see that it’s Finished:

When you see Finished in the Output pane, the solution has been updated.
Line 1 of the Program.cs file:2. Scroll down to the line containing PDFNet.Initialize(“YOUR_PDFTRON_LICENSE_KEY”); and replace the words in quotes with the copy of your trial license key. If you’re logged in to Apryse.com, your license key will automatically replace YOUR_PDFTRON_LICENSE_KEY in the code below.

Add your license key.
3. Click GetStarted_DotNET on the Visual Studio Main toolbar to run the code. The Windows command line will open and you will see:

The Windows command line opens and you see Hello World!
Once you click GetStarted_DotNET above, the code initializes the Apryse Server SDK in the .NET environment, creates the sample PDF document, and performs basic PDF operations such as reading document information, extracting text, and saving output. The code also demonstrates essential API usage for tasks like loading documents and manipulating pages.
4. Exit out of the command line and navigate in File Explorer to the Windows folder where the PDF file has been saved (this is the location you specified in step 2 of the 1. Create a new project section above).

Navigate to the location of the PDF file you created.
5. Open the linearized_output.pdf which you created by integrating the Apryse Server SDK!
Now that you have successfully run the OfficeToPDFTest sample (in section 1) and integrated the Apryse Server SDK .NET PDF Library into your application, you can try out 50+ samples depending on your needs.

Based on your needs, you can browse over 50 samples to try.
6. To try additional samples, go to section 2. Run a sample > step 3 above and choose another sample to run.
This guide will help you set up Apryse SDK serverless Azure functions. Your free trial includes unlimited trial usage and support from solution engineers.
In this particular guide, we will demonstrate how to set up an Azure function to use Apryse SDK.
First, create an Azure function using this guide.
Next, edit your csproj to include PDFNetC.dll and reference PDFTronDotNet.dll from the download package.
Once you have followed the initial setup instructions, you can begin calling Apryse SDK APIs in your Azure function source. For example:
You can update C# script of your Azure function project with the following code or download the source code from our github repository. This snippet shows how to process a request sent from a client to convert an office document to PDF and send the output to client.
The last step is to publish your Azure function and have it running and its url ready. Make sure to set Settings/Configuration/General settings/Platform to 64-bit in Azure portal.
In order to use this Azure function to convert an office document to PDF, the client needs to post a REST API request to the server. The request must include json data structured as in C# code above.
Upon receiving a client's request, a response will be sent back to the client including the base64 encoded pdf output using the same json structure. All the client needs to do now is decode the encoded data into pdf. That's it!
You can access the sample python code on Github. After cloning the repository and installing necessary packages, please refer to /client/README.txt for detailed instructions. Navigate to the client folder, run the following command, and see the reponse to client's request in the console and check the output in the output folder:
The client will send a REST API request to convert /input/simple-word_2007.docx to pdf and the server will send back the encoded data, which will then be saved as pdf in the output folder.
You can experiment with your own office document by putting it inside input folder:
We have shown how to set an Azure function using Apryse SDK. You can now experiment making your own functions, URLs, and can fully utilize Apryse SDK. If your have any questions, please don't hesitate to contact us!
In this guide, you'll explore sample PDFNet projects to understand the types of PDF outputs you can create with the Apryse Server SDK. You'll also create a simple .NET application, add the Apryse Server SDK, and learn how to generate files programmatically.
For Alpine Linux-specific instructions, see the Alpine Linux guide.
Before you start:
Apryse collects some data regarding your usage of the SDK for product improvement.
If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.
A commercial license key is required for use in a production environment. Contact sales to purchase a commercial license key.
License keys are uniquely generated and strictly confidential. Don't publish or store them in any public location, including public GitHub repositories.
In this section, you’ll use the OfficeToPDFTest sample to convert a DOCX file to PDF using the Microsoft Office conversion API. You can use this sample to understand how document conversion works and as a reference for your own implementations.
PDFNetC64.tar.gz tarball file and select Extract to..../Home/ApryseSamples/PDFNetC64/Samples/LicenseKey/CS/LicenseKey.cs and double-click to open the LicenseKey.cs file before running the sample.private static string key = “YOUR_PDFTRON_LICENSE_KEY”; line and replace the quoted text with your trial license key. Don't change any other information in this file. Save your changes.LicenseKey.cs
7. To run the sample, navigate to /Home/ApryseSamples/PDFNetC64/Samples/OfficeToPDFTest/CS.
The folder path may vary depending on the architecture and tarball you downloaded (for example, x86‑64 vs. ARM64).
8. Right-click the CS folder, then select Open in Terminal.
9. In the terminal, run this script:
When you run the RunTest.sh script, the sample loads a Microsoft Office document, converts it to PDF, saves the PDF, and outputs the following status messages to the console. For more details, review the OfficeToPDFsample code and the Convert MS Office (Word, Excel, PowerPoint) to PDF overview.
10. Go to the /Home/ApryseSamples/PDFNetC64/Samples/TestFiles/Output directory to verify these output PDF files are present:
11. Open the PDF files to see the converted output. The original DOCX files are located in the PDFNetC64/Samples/TestFiles folder.

Open the PDF files to see the converted output.
Create a simple .NET application that uses the Apryse Server SDK and PDFNet library to generate a PDF programmatically. In this section, you’ll set up a minimal project, add the required code, and run a script that creates a blank PDF document. This example provides a practical foundation for building more advanced document‑generation workflows.
Set up your project by creating a folder and preparing your workspace for the application.
A successful output looks similar to:
Next, integrate the Apryse Server SDK into your .NET application and add the code needed to generate a PDF.
Home/NewApryseProject directory, install the Apryse SDK:The command downloads the .NET package from NuGet and makes the library available to your application. A successful output looks like:
2. Open the NewApryseProject/Program.cs file in Visual Studio Code or your preferred code editor.
3. Replace Program.cs with the following code, update your license key, and save your changes.
With this code, you can:
Main function to generate the PDF, while the PDFNet engine handles license initialization and cleanup.Finally, build and run your application to confirm that the Apryse Server SDK is working correctly. After the application runs successfully, it will generate a blank PDF file locally.
A successful output looks similar to:
3. Navigate to the Home > NewApryseProject folder.
4. Verify the blank output.pdf file was generated programmatically using the Apryse Server SDK:
Now that you have successfully run an OfficeToPDFTest sample (in section 1) and integrated the Apryse Server SDK .NET PDF library into your application, you can try out 50+ samples depending on your needs.

You can try over fifty samples for the Apryse Server SDK.
To try additional samples, go to section 1. Convert DOCX to PDF > step 7, and choose another sample to run.
In this guide, you'll explore sample PDFNet projects to understand the types of PDF outputs you can create with the Apryse Server SDK. You'll also create a simple .NET application, add the Apryse Server SDK, and learn how to generate files programmatically.
Before you start:
Apryse collects some data regarding your usage of the SDK for product improvement.
If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.
A commercial license key is required for use in a production environment. Contact sales to purchase a commercial license key.
License keys are uniquely generated and strictly confidential. Don't publish or store them in any public location, including public GitHub repositories.
In this section, you’ll use the OfficeToPDFTest sample to convert a DOCX file to PDF using the Microsoft Office conversion API. You can use this sample to understand how document conversion works and as a reference for your own implementations.
PDFNetCMac.zip file to unzip it.Documents/ApryseSamples directory and remove the quarantine attribute from all files so the sample can run:Instead of using the terminal, go to System Settings > Privacy & Security and click Open Anyway. For more, see opening an app on a Mac.
6. Open the /Documents/ApryseSamples/PDFNetCMac/Samples/LicenseKey/CS/LicenseKey.cs file in Visual Studio Code.
7. Go to the private static string key = “YOUR_PDFTRON_LICENSE_KEY”; line and replace the quoted text with your trial license key. Don't change any other information in this file. Save your changes.
LicenseKey.cs
8. To run the sample, navigate to /Documents/ApryseSamples/PDFNetCMac/Samples/OfficeToPDFTest/CS.
9. Right-click the CS folder and select New Terminal at Folder.
10. In the terminal, run this script:
When you run the RunTest.sh script, the sample loads a Microsoft Office document, converts it to PDF, saves the PDF, and outputs the following status messages to the console. For more details, review the OfficeToPDF sample code and the Convert MS Office (Word, Excel, PowerPoint) to PDF overview.
11. Go to the /Documents/ApryseSamples/PDFNetCMac/Samples/TestFiles/Output directory to verify these output PDF files are present:
12. Open the PDF files to see the converted output. The original DOCX files are located in the PDFNetCMac/Samples/TestFiles folder.

Open the PDF files to see the converted output.
Create a simple .NET application that uses the Apryse Server SDK and PDFNet library to generate a PDF programmatically. In this section, you’ll set up a minimal project, add the required code, and run a script that creates a blank PDF document. This example provides a practical foundation for building more advanced document‑generation workflows.
Set up your project by creating a folder and preparing your workspace for the application.
A successful output looks similar to:
Next, integrate the Apryse Server SDK into your .NET application and add the code needed to generate a PDF.
Documents/NewApryseProject directory, install the Apryse SDK:The command downloads the .NET package from NuGet and makes the library available to your application. A successful output looks like:
2. Open the NewApryseProject/Program.cs file in Visual Studio Code or your preferred code editor.
3. Replace Program.cs with the following code, update your license key, and save your changes:
With this code, you can:
Main function to generate the PDF, while the PDFNet engine handles license initialization and cleanup.Finally, build and run your application to confirm that the Apryse Server SDK is working correctly. After the application runs successfully, it will generate a blank PDF file locally.
A successful output looks similar to:
3. Navigate to the Documents > NewApryseProject folder.
4. Verify the blank output.pdf file was generated programmatically using the Apryse Server SDK.
Now that you have successfully run an OfficeToPDFTest sample (in section 1) and integrated the Apryse Server SDK .NET PDF library into your application, you can try out 50+ samples depending on your needs.

You can try over fifty samples for the Apryse Server SDK.
To try additional samples, go to section 1. Convert DOCX to PDF > step 8, and choose another sample to run.
Did you find this helpful?
Trial setup questions?
Ask experts on DiscordNeed other help?
Contact SupportPricing or product questions?
Contact Sales