---
title: "Getting started with DWS Processor API"
canonical_url: "https://www.nutrient.io/guides/dws-processor/getting-started/"
md_url: "https://www.nutrient.io/guides/dws-processor/getting-started.md"
last_updated: "2026-05-27T15:15:53.462Z"
description: "Step-by-step guide to get started with DWS Processor API using the dashboard, a live API key, and first-request examples."
---
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](https://www.nutrient.io/api/processor-api/), [Processor API pricing](/api/pricing/processor-api/), or the [Postman collection](/guides/dws-processor/getting-started/postman-collection.md).
## Try it in 30 seconds
Want to see it in action right away? Copy and paste these commands into your terminal:
```bash
# Create sample HTML.
echo 'Hello from Nutrient!
' > 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](https://dashboard.nutrient.io/sign_up/?product=processor) for free. Then replace `YOUR_API_KEY` in the command above with your key.
## Getting started
1. [Sign up](https://dashboard.nutrient.io/sign_up/?product=processor) 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.
3. Copy your live API key and select an [API tool](https://dashboard.nutrient.io/processor-api/playground/) 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](https://www.nutrient.io/api/assets/downloads/samples/html/index.html).
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](https://www.nutrient.io/guides/dws-processor/supported-languages.md) guide.
### HTTP
```http
POST https://api.nutrient.io/processor/generate_pdf HTTP/1.1
Content-Type: multipart/form-data; boundary=--customboundary
Authorization: Bearer
--customboundary
Content-Disposition: form-data; name="html"; filename="index.html"
Content-Type: text/html
(html data)
--customboundary--
```
### PHP
```php
'https://api.nutrient.io/processor/generate_pdf',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_POSTFIELDS => array(
'html' => new CURLFILE('index.html')
),
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer '
),
CURLOPT_FILE => $FileHandle,
));
$response = curl_exec($curl);
curl_close($curl);
fclose($FileHandle);
```
### Python
```python
import requests
import json
response = requests.request(
'POST',
'https://api.nutrient.io/processor/generate_pdf',
headers = {
'Authorization': 'Bearer '
},
files = {
'html': open('index.html', 'rb')
},
stream = True
)
if response.ok:
with open('result.pdf', 'wb') as fd:
for chunk in response.iter_content(chunk_size=8096):
fd.write(chunk)
else:
print(response.text)
exit()
```
### JavaScript
```javascript
// This code requires Node.js. Do not run this code directly in a web browser.
const axios = require("axios");
const FormData = require("form-data");
const fs = require("fs");
const formData = new FormData();
formData.append("html", fs.createReadStream("index.html"));
(async () => {
try {
const response = await axios.post(
"https://api.nutrient.io/processor/generate_pdf",
formData,
{
headers: formData.getHeaders({
Authorization: "Bearer ",
}),
responseType: "stream",
},
);
response.data.pipe(fs.createWriteStream("result.pdf"));
} catch (e) {
const errorString = await streamToString(e.response.data);
console.log(errorString);
}
})();
function streamToString(stream) {
const chunks = [];
return new Promise((resolve, reject) => {
stream.on("data", (chunk) => chunks.push(Buffer.from(chunk)));
stream.on("error", (err) => reject(err));
stream.on("end", () => resolve(Buffer.concat(chunks).toString("utf8")));
});
}
```
### C#
```csharp
using System;
using System.IO;
using System.Net;
using RestSharp;
namespace PspdfkitApiDemo
{
class Program
{
static void Main(string[] args)
{
var client = new RestClient("https://api.nutrient.io/processor/generate_pdf");
var request = new RestRequest(Method.POST).AddHeader("Authorization", "Bearer ").AddFile("html", "index.html");
request.AdvancedResponseWriter = (responseStream, response) =>
{
if (response.StatusCode == HttpStatusCode.OK)
{
using (responseStream)
{
using var outputFileWriter = File.OpenWrite("result.pdf");
responseStream.CopyTo(outputFileWriter);
}
}
else
{
var responseStreamReader = new StreamReader(responseStream);
Console.Write(responseStreamReader.ReadToEnd());
}
};
client.Execute(request);
}
}
}
```
### Java
```java
package com.example.pspdfkit;
import java.io.File;
import java.io.IOException;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.StandardCopyOption;
import org.json.JSONArray;
import org.json.JSONObject;
import okhttp3.MediaType;
import okhttp3.MultipartBody;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;
public final class PspdfkitApiExample {
public static void main(final String[] args) throws IOException {
final RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM).addFormDataPart(
"html",
"index.html",
RequestBody.create(
MediaType.parse("text/html"),
new File("index.html")
)
).build();
final Request request = new Request.Builder().url("https://api.nutrient.io/processor/generate_pdf").method("POST", body).addHeader("Authorization", "Bearer ").build();
final OkHttpClient client = new OkHttpClient().newBuilder().build();
final Response response = client.newCall(request).execute();
if (response.isSuccessful()) {
Files.copy(
response.body().byteStream(),
FileSystems.getDefault().getPath("result.pdf"),
StandardCopyOption.REPLACE_EXISTING
);
} else {
// Handle the error
throw new IOException(response.body().string());
}
}
}
```
### Shell
```shell
curl -X POST https://api.nutrient.io/processor/generate_pdf \
-H "Authorization: Bearer " \
-o result.pdf \
--fail \
-F html=@index.html
```
### Shell (Windows)
```powershell
curl -X POST https://api.nutrient.io/processor/generate_pdf ^
-H "Authorization: Bearer " ^
-o result.pdf ^
--fail ^
-F html=@index.html
```
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](https://dashboard.nutrient.io/processor-api/playground/) in our API playground, browse the full set of available task pages on the [Processor API overview](https://www.nutrient.io/api/processor-api/) and [tools overview](https://www.nutrient.io/api/tools-overview/), or consult the [REST API reference](https://www.nutrient.io/api/reference/public/) for detailed endpoint documentation.
---
## Related pages
- [Nutrient DWS MCP Server](/guides/dws-processor/getting-started/mcp-server.md)
- [Postman collection](/guides/dws-processor/getting-started/postman-collection.md)
- [Zapier integration](/guides/dws-processor/getting-started/zapier-integration.md)