Nutrient Document Web Services (DWS) Processor API is a service that enables fast and easy integration to instantly generate, convert, and modify PDF documents in your workflows.

Use this guide when you want a DWS Processor get started path via the dashboard, need to create a free trial account, get a live API key, and make your first request.

If you need broader evaluation context before making that first call, continue to the Processor API overview, Processor API pricing, or the Postman collection.

Try it in 30 seconds

Want to see it in action right away? Copy and paste these commands into your terminal:

Terminal window
# Create sample HTML.
echo '<html><body><h1>Hello from Nutrient!</h1></body></html>' > index.html
# Convert to PDF (replace YOUR_API_KEY).
curl -X POST 'https://api.nutrient.io/build' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-F 'index.html=@index.html' \
-F 'instructions={"parts":[{"html":"index.html"}]}' \
-o hello.pdf

Get your API key by signing up(opens in a new tab) for free. Then replace YOUR_API_KEY in the command above with your key.

Getting started

  1. Sign up(opens in a new tab) for a free account in the DWS dashboard. The signup link preselects DWS Processor API for you.

  2. If you’re prompted to choose a product, click Get Started on the Processor API card.


    DWS Processor API card


  3. Copy your live API key and select an API tool(opens in a new tab) to get started. Below you’ll see a demonstration of the PDF generation API.

    To make requests using your account, pass the API key to every call you make.

    On the free plan, the output is still watermarked, even when you use a pdf_live_ key. Upgrade to a paid plan for watermark-free output.

  4. Add an HTML file named index.html to your project folder. You can also use our sample file.

  5. Copy the code below and run it from the same folder you added the files to. For a list of all programming languages that support HTTP requests, refer to our supported languages guide.

POST https://api.nutrient.io/processor/generate_pdf HTTP/1.1
Content-Type: multipart/form-data; boundary=--customboundary
Authorization: Bearer <add-your-live-API-key-here>
--customboundary
Content-Disposition: form-data; name="html"; filename="index.html"
Content-Type: text/html
(html data)
--customboundary--

Similarly, you can use other DWS Processor API endpoints to convert, modify, and manipulate documents. To explore more endpoints, try other DWS Processor API endpoints(opens in a new tab) in our API playground, browse the full set of available task pages on the Processor API overview and tools overview, or consult the REST API reference for detailed endpoint documentation.