Name: PDF Toolkit API: Merge, Split, Redact & Fill PDFs
Brand: freedailypro
SKU: api-freedailypro-pdf-toolkit-api
Availability: InStock
Author: API Market

FreeDailyPro

# PDF Toolkit API

## Overview

The PDF Toolkit API handles the everyday PDF jobs that apps need in one HTTP call each. Its 13 endpoints read and fill PDF forms, redact sensitive areas, merge and split files, rotate, extract and reorder pages, add page numbers and text watermarks, flatten forms, repair damaged files and compress large ones. You upload the PDF as multipart form data and get the finished PDF back in the response, with no polling and no storage step.

It is built for developers of document workflows, HR and onboarding tools, legal and finance back offices, e-signature and form products, and any app where users upload PDFs. Form parsing and multi-file splits return JSON; every other endpoint returns the PDF file itself, so you can save it, stream it to the user or pass it to the next step. Files are processed in memory and nothing is stored.

## Features

*   **13 endpoints**: forms, redaction, merge, split, rotate, page numbers, watermark, extract, organize, flatten, repair and compress.
*   **Fillable forms**: list a form's fields, then fill text fields and checkboxes and optionally flatten the result.
*   **True redaction**: covered text is removed from the file, not just hidden under a black box.
*   **Page tools**: reorder pages, insert blank pages, rotate selected pages and extract page ranges in one call.
*   **Smart compression**: aims for half the size or a target you set, and shrinks pictures only as much as needed.
*   **Files in, files out**: send multipart form data and receive the PDF directly in the response.
*   **Private by design**: files are processed in memory and nothing is stored.
*   **Rate limit**: up to 10 requests per second on every plan.

## Use Cases

*   **Onboarding and HR apps**: pre-fill employment and tax forms from your database and flatten them before sending.
*   **Legal and compliance teams**: redact account numbers, names and addresses before sharing documents.
*   **Document portals**: merge uploaded files into one PDF, or split a large scan into separate documents.
*   **Reporting tools**: add page numbers and DRAFT or CONFIDENTIAL watermarks to generated reports.
*   **Email and storage limits**: compress scanned PDFs before attaching or archiving them.
*   **Upload pipelines**: repair PDFs that other libraries fail to open before processing them further.

## API Documentation

### Base URL

All requests use the following base URL.

```
https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api
```

### Authentication

All requests are authenticated with the `x-api-market-key` header.

```
x-api-market-key: YOUR_API_KEY
```

Replace `YOUR_API_KEY` with your actual API key.

### Endpoints

Every endpoint takes `POST` with `multipart/form-data`. Text options are sent as form fields next to the file. Uploads are limited to 10 MB per request in total.

#### 1. List the fields of a PDF form

Returns every fillable field in a PDF form with its name, kind and current value. Call it before `fillable-forms/fill` to learn the exact field names to send.

**Method:** `POST`

**Endpoint:** `/v1/fillable-forms/parse`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `file` | body | The PDF form | file | Yes | - | 10 MB |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/fillable-forms/parse' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'file=@form.pdf'
```

**Example Response (200 OK):**

```json
{
  "fieldCount": 3,
  "fields": [
    {
      "name": "full_name",
      "kind": "text",
      "type": "text",
      "readOnly": false,
      "required": false,
      "value": "",
      "multiline": false
    },
    {
      "name": "email",
      "kind": "text",
      "type": "text",
      "readOnly": false,
      "required": false,
      "value": "",
      "multiline": false
    },
    {
      "name": "agree_terms",
      "kind": "checkbox",
      "type": "checkbox",
      "readOnly": false,
      "required": false,
      "checked": false,
      "value": false
    }
  ]
}
```

#### 2. Fill a PDF form

Fills text fields and checkboxes of a PDF form and returns the filled PDF. Set `flatten` to `true` to lock the values so the form can no longer be edited.

**Method:** `POST`

**Endpoint:** `/v1/fillable-forms/fill`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `file` | body | The PDF form | file | Yes | - | 10 MB |
| `values` | body | JSON object of text field values, for example `{"full_name":"Maria Lopez"}` | string | No | - | - |
| `checked` | body | JSON object of checkbox states, for example `{"agree_terms":true}` | string | No | - | - |
| `flatten` | body | `true` to flatten the filled form | string | No | `false` | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/fillable-forms/fill' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'file=@form.pdf' \
  -F 'values={"full_name":"Maria Lopez","email":"maria@example.com"}' \
  -F 'checked={"agree_terms":true}' \
  -F 'flatten=false' \
  -o filled.pdf
```

**Example Response (200 OK):**

```http
HTTP/1.1 200 OK
Content-Type: application/pdf

<filled PDF form, 2,083 bytes>
```

#### 3. Redact areas of a PDF

Blacks out the boxes you give and removes the text underneath, so it can no longer be selected or extracted. Boxes are grouped by 1-based page number and measured in PDF points from the top-left corner of the page.

**Method:** `POST`

**Endpoint:** `/v1/redact-pdf`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `file` | body | The PDF file | file | Yes | - | 10 MB |
| `boxes` | body | JSON object mapping a page number to a list of boxes with `x`, `y`, `width` and `height` in points; `y` is measured from the top of the page | string | Yes | - | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/redact-pdf' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'file=@statement.pdf' \
  -F 'boxes={"1":[{"x":65,"y":125,"width":300,"height":24}]}' \
  -o redacted.pdf
```

**Example Response (200 OK):**

```http
HTTP/1.1 200 OK
Content-Type: application/pdf

<redacted PDF, 1,119 bytes>
```

In our test the account number inside the box was gone from the page text of the returned file.

#### 4. Merge PDFs

Joins two or more PDFs into one file in the order you send them. Repeat the `files` field once per PDF.

**Method:** `POST`

**Endpoint:** `/v1/pdf/merge`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `files` | body | Two or more PDF files, repeated in the order to merge | file[] | Yes | - | 10 MB in total |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/pdf/merge' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'files=@first.pdf' \
  -F 'files=@second.pdf' \
  -o merged.pdf
```

**Example Response (200 OK):**

```http
HTTP/1.1 200 OK
Content-Type: application/pdf

<merged PDF, 1,378 bytes>
```

#### 5. Split a PDF

Splits a PDF into groups of pages. Separate groups with a semicolon, and use commas and ranges inside a group. Several groups come back as JSON with each file base64-encoded. A single group, or `combineIntoOne=true`, returns one PDF.

**Method:** `POST`

**Endpoint:** `/v1/pdf/split`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `file` | body | The PDF file | file | Yes | - | 10 MB |
| `ranges` | body | Page groups separated by `;`, for example `1;2-3` for two files or `1,3` for one | string | Yes | - | - |
| `combineIntoOne` | body | `true` to return all selected pages as one PDF | string | No | `false` | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/pdf/split' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'file=@document.pdf' \
  -F 'ranges=1;2-3'
```

**Example Response (200 OK):**

```json
{
  "files": [
    {
      "name": "split_1.pdf",
      "base64": "JVBERi0xLjcKJYGBgYEKCjUg..."
    },
    {
      "name": "split_2.pdf",
      "base64": "JVBERi0xLjcKJYGBgYEKCjUg..."
    }
  ]
}
```

The `base64` values are shortened here. Each one decodes to a complete PDF: in our test `split_1.pdf` held page 1 and `split_2.pdf` held pages 2 and 3.

#### 6. Rotate pages

Rotates the pages you choose by 90, 180 or 270 degrees and leaves the rest unchanged.

**Method:** `POST`

**Endpoint:** `/v1/pdf/rotate`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `file` | body | The PDF file | file | Yes | - | 10 MB |
| `rotations` | body | JSON object mapping a 1-based page number to degrees, for example `{"1":90,"3":180}` | string | Yes | - | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/pdf/rotate' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'file=@document.pdf' \
  -F 'rotations={"1":90,"3":180}' \
  -o rotated.pdf
```

**Example Response (200 OK):**

```http
HTTP/1.1 200 OK
Content-Type: application/pdf

<rotated PDF, 1,182 bytes>
```

#### 7. Add page numbers

Stamps page numbers on every page or on a page range.

**Method:** `POST`

**Endpoint:** `/v1/pdf/add-page-numbers`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `file` | body | The PDF file | file | Yes | - | 10 MB |
| `position` | body | `bottom-center`, `bottom-right`, `bottom-left`, `top-center`, `top-right` or `top-left` | string | No | - | - |
| `format` | body | `plain` (3), `page-of-total` (3 of 10) or `prefixed` (uses `prefix`) | string | No | - | - |
| `prefix` | body | Text placed before the number when `format` is `prefixed` | string | No | - | - |
| `startAt` | body | First number | number | No | 1 | - |
| `fontSize` | body | Font size in points | number | No | - | - |
| `pageRange` | body | Pages to number, for example `2-10` | string | No | All pages | - |
| `skipFirstPage` | body | `true` to leave the first page unnumbered | string | No | `false` | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/pdf/add-page-numbers' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'file=@document.pdf' \
  -F 'position=bottom-center' \
  -F 'format=page-of-total' \
  -o numbered.pdf
```

**Example Response (200 OK):**

```http
HTTP/1.1 200 OK
Content-Type: application/pdf

<numbered PDF, 1,977 bytes>
```

#### 8. Add a text watermark

Stamps text on every page, for example CONFIDENTIAL or DRAFT.

**Method:** `POST`

**Endpoint:** `/v1/pdf/watermark`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `file` | body | The PDF file | file | Yes | - | 10 MB |
| `text` | body | Watermark text | string | Yes | - | - |
| `position` | body | Where to place the text, for example `center` | string | No | `center` | - |
| `opacity` | body | Opacity from 0 to 1 | number | No | - | 1 |
| `fontSize` | body | Font size in points | number | No | - | - |
| `rotationDegrees` | body | Rotation of the text in degrees | number | No | - | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/pdf/watermark' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'file=@document.pdf' \
  -F 'text=CONFIDENTIAL' \
  -F 'position=center' \
  -F 'opacity=0.3' \
  -F 'fontSize=48' \
  -F 'rotationDegrees=45' \
  -o watermarked.pdf
```

**Example Response (200 OK):**

```http
HTTP/1.1 200 OK
Content-Type: application/pdf

<watermarked PDF, 2,172 bytes>
```

#### 9. Extract pages

Returns a new PDF that holds only the pages you choose, in document order.

**Method:** `POST`

**Endpoint:** `/v1/pdf/extract`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `file` | body | The PDF file | file | Yes | - | 10 MB |
| `pages` | body | Pages or ranges separated by commas, for example `1,3-5,8` | string | Yes | - | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/pdf/extract' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'file=@document.pdf' \
  -F 'pages=1,3' \
  -o extracted.pdf
```

**Example Response (200 OK):**

```http
HTTP/1.1 200 OK
Content-Type: application/pdf

<PDF with pages 1 and 3, 971 bytes>
```

#### 10. Reorder, rotate, remove or insert pages

Builds a new PDF from a list of page specs. Each spec is a source page (0-based `index`, optional `rotation`) or a blank page. Pages you leave out are removed.

**Method:** `POST`

**Endpoint:** `/v1/pdf/organize`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `file` | body | The PDF file | file | Yes | - | 10 MB |
| `pageSpecs` | body | JSON array such as `[{"type":"source","index":2},{"type":"blank"},{"type":"source","index":0,"rotation":90}]` | string | Yes | - | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/pdf/organize' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'file=@document.pdf' \
  -F 'pageSpecs=[{"type":"source","index":2},{"type":"blank"},{"type":"source","index":0,"rotation":90}]' \
  -o organized.pdf
```

**Example Response (200 OK):**

```http
HTTP/1.1 200 OK
Content-Type: application/pdf

<reorganized PDF, 1,007 bytes>
```

In our test this returned page 3, then a blank page, then page 1 rotated 90 degrees.

#### 11. Flatten a PDF

Turns form fields and annotations into fixed page content so they can no longer be edited. The output carries a small "Flattened via FreeDailyPro.com" line with the date in the bottom-left corner.

**Method:** `POST`

**Endpoint:** `/v1/pdf/flatten`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `file` | body | The PDF file | file | Yes | - | 10 MB |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/pdf/flatten' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'file=@form.pdf' \
  -o flattened.pdf
```

**Example Response (200 OK):**

```http
HTTP/1.1 200 OK
Content-Type: application/pdf

<flattened PDF, 2,375 bytes>
```

#### 12. Repair a PDF

Rebuilds the internal structure of a PDF that will not open cleanly and returns the repaired file.

**Method:** `POST`

**Endpoint:** `/v1/pdf/repair`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `file` | body | The PDF file | file | Yes | - | 10 MB |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/pdf/repair' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'file=@damaged.pdf' \
  -o repaired.pdf
```

**Example Response (200 OK):**

```http
HTTP/1.1 200 OK
Content-Type: application/pdf

<repaired PDF, 1,006 bytes>
```

#### 13. Compress a PDF

Shrinks a PDF. With `level=auto` it aims for half the original size, or for `targetFileSize`, by tidying the file structure first and then shrinking pictures only as much as needed. Text is not changed.

**Method:** `POST`

**Endpoint:** `/v1/pdf/compress`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `file` | body | The PDF file | file | Yes | - | 10 MB |
| `level` | body | `auto`, `medium` (balanced pictures) or `strong` (smallest pictures) | string | No | `auto` | - |
| `targetFileSize` | body | Size to aim for, such as `2MB`, `500KB` or a number of bytes (`level=auto` only) | string | No | Half the original | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/freedailypro/pdf-toolkit-api/v1/pdf/compress' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -F 'file=@scan.pdf' \
  -F 'level=auto' \
  -o compressed.pdf
```

**Example Response (200 OK):**

```http
HTTP/1.1 200 OK
Content-Type: application/pdf

<compressed PDF, 261,629 bytes>
```

In our test a 541,277-byte scanned PDF came back at 261,629 bytes. A file that is already at or under the target returns 422:

```json
{
  "error": "The file is already at or under the target size, so nothing was changed.",
  "originalBytes": 1318
}
```

## Status Codes

| Code | Status | Description |
|---|---|---|
| 200 | OK | The request succeeded. The body is the PDF file, or JSON for form parsing and multi-file splits. |
| 400 | Bad Request | A required field is missing or a value is invalid, for example `rotations` that is not a JSON object. The JSON body names the field to fix. |
| 401 | Unauthorized | The `x-api-market-key` header is missing or the key is not valid. |
| 403 | Forbidden | Your key does not have an active subscription that includes this endpoint. |
| 404 | Not Found | The path does not match an endpoint of this API. Check the Base URL and path. |
| 422 | Unprocessable Entity | The file was read but could not be processed, for example a PDF that is already under the compression target. |
| 429 | Too Many Requests | You went over 10 requests per second or used up the monthly quota of your plan. |
| 500 | Internal Server Error | The request failed on the server. Retry once, then contact us if it continues. |
| 503 | Service Unavailable | The service is temporarily unavailable. Retry after a short wait. |

## Rate Limits

Every plan allows up to 10 requests per second, and each plan has its own monthly quota of API calls. When you exceed either, the API returns `429 Too Many Requests`. Throttle your requests, back off before retrying, and honour the `Retry-After` header when it is present.

## FAQ

*   **How do I know which field names to send to the fill endpoint?**
    Call `/v1/fillable-forms/parse` first. It returns every field with its exact name and kind (`text` or `checkbox`), and you use those names as keys in `values` and `checked`.

*   **Which way do redaction coordinates run?**
    Boxes are in PDF points, with `x` from the left edge and `y` from the top edge of the page. A US Letter page is 612 by 792 points.

*   **How do I get several files from split?**
    Separate the groups with a semicolon, for example `1;2-3`. Commas inside a group only add pages to that group, so `1,2-3` returns one PDF with pages 1 to 3.

*   **What does the page number format option accept?**
    Use `plain`, `page-of-total` or `prefixed`. With `prefixed`, the text in `prefix` is placed before the number.

*   **Why did compress return 422?**
    The file is already at or under the target size, so nothing was changed. Send a smaller `targetFileSize` or use `level=strong` for more savings.

*   **Does flatten add anything to the page?**
    Yes. It adds a small "Flattened via FreeDailyPro.com" line with the date in the bottom-left corner.

*   **How large can my files be?**
    Up to 10 MB per request in total through API.market, including every file in a merge.

*   **Why does the API Playground return 400 for fields I did not fill?**
    The Playground pre-fills optional fields with placeholder values such as `string` or `0`. Clear the optional fields you are not using before you run a request.

*   **Do you keep my files?**
    No. Files are processed in memory and discarded after the response is sent.

## Contact Us

If you have any questions or need support, reach out through the chat embedded on this page or email us at hello@magicapi.com.


PDF API to merge, split, compress, redact, watermark, rotate and extract pages, and fill PDF forms. Upload a file, get the PDF back in one call.

PDF Toolkit API: Merge, Split, Redact & Fill PDFs