# pdf.redact

> Remove texts and areas from a PDF for good.

> Coming soon. The hosted API is not live yet, and this page describes the planned service as of 16 November 2026. [Get notified](https://pdfluent.com/contact/?topic=hosted) when it opens.

Source: https://pdfluent.com/docs/api/reference/pdf-redact/

Remove texts and areas from a PDF for good.

`POST /v1/pdf/redact`

| | |
|---|---|
| Input | one file, sent as `multipart/form-data`; the optional `options` part is a JSON object |
| Output | one PDF |
| Credits | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| Limits | [size, page and time limits: no claim ID yet] |
| Reads or changes the document | returns a changed copy |
| Error statuses | 400, 413, 422, 500, 501, 504 (see [Errors](https://pdfluent.com/docs/api/errors/)) |

## Options

| Option | Type | Required | Default | Description |
|---|---|---|---|---|
| `case_sensitive` | boolean | no | `false` | Match case. Default false. |
| `pages` | array of integer | no |  | Limit the terms to these one-based pages. Default: all pages. |
| `password` | string | no |  | Password of an encrypted document. |
| `regex` | boolean | no | `false` | Treat the terms as regular expressions. Default false. |
| `regions` | array of object | no |  | Areas to remove. |
| `terms` | array of string | no | `[]` | Texts to remove for good. |

## Example

### curl

```sh
curl -sS -f -X POST "$PDFLUENT_API_URL/v1/pdf/redact" \
  -H "x-api-key: $PDFLUENT_API_KEY" \
  -F file=@structured.pdf \
  -F 'options={"terms":["Standing"]}' \
  -o result.pdf
```

### Python

```python
import json
import os

import requests

options = {"terms": ["Standing"]}

parts = [
    ("file", ("structured.pdf", open("structured.pdf", "rb"))),
    ("options", (None, json.dumps(options))),
]

response = requests.post(
    os.environ["PDFLUENT_API_URL"] + "/v1/pdf/redact",
    headers={"x-api-key": os.environ["PDFLUENT_API_KEY"]},
    files=parts,
)
response.raise_for_status()

with open("result.pdf", "wb") as out:
    out.write(response.content)
```

### Node.js

```js
import { openAsBlob } from 'node:fs';
import { writeFile } from 'node:fs/promises';

const form = new FormData();
form.append('file', await openAsBlob("structured.pdf"), "structured.pdf");
form.append('options', JSON.stringify({"terms":["Standing"]}));

const response = await fetch(process.env.PDFLUENT_API_URL + "/v1/pdf/redact", {
  method: 'POST',
  headers: { 'x-api-key': process.env.PDFLUENT_API_KEY },
  body: form,
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);

await writeFile("result.pdf", Buffer.from(await response.arrayBuffer()));
```

The key goes in the `x-api-key` header; see [Authentication](https://pdfluent.com/docs/api/authentication/). Every response carries `x-pdfluent-pages` and `x-pdfluent-credits`.
