# Scan to PDF

- Human page: https://happytails.ai/en/pdf-tools/scan-to-pdf/
- Markdown: https://happytails.ai/en/pdf-tools/scan-to-pdf.md
- Structured JSON: https://happytails.ai/agents/en/pdf-tools/scan-to-pdf/index.json
- Visibility: public

## Tool capabilities

| Property | Value |
| --- | --- |
| Tool ID | `scan-to-pdf` |
| Category | pdf-tools |
| Implementation | Registered implementation. Registration alone is not a production-quality guarantee. |
| Browser execution | Use the visible action or interactive controls. |
| Browser processing | Server required |
| HTTP API | /api/v1/tools/scan-to-pdf/run |
| Browser-agent interface | run_current_tool |

### Implementation notes

Processed by the local, self-hosted engine. No third-party conversion service is used. Upload photos or scans in page order. Automatic perspective correction works best with a clear page border. Review the exported PDF. Direct camera capture is not included yet.

### Inputs and settings

No free-text input is required. Use the file inputs and/or settings below.

Accepted browser files: `.png,.jpg,.jpeg,.webp`. Multiple files are supported.

Browser file-input limit: 20971520 bytes in total. HTTP limits can differ.

| Setting | Meaning | Control type | Default | Constraints |
| --- | --- | --- | --- | --- |
| `crop` | Automatically detect and crop page edges | checkbox | true |  |

### HTTP contract

API calls process supplied data on the server. The website origin is `https://happytails.ai`. Server API hosting is not connected on the public website yet. Use your local server origin to test these requests.

```http
POST https://happytails.ai/api/v1/tools/scan-to-pdf/run
Content-Type: application/json
```

[Detailed operation reference](https://happytails.ai/en/api/tools/scan-to-pdf.md) · [Shared API guide](https://happytails.ai/en/api.md)

#### Limits

| Limit | Value |
| --- | --- |
| request_bytes | 31457280 |
| input_characters | 1000000 |
| files_bytes | 20971520 |
| max_files | 20 |
| timeout_seconds | 90 |

#### Complete input schema

```json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "input": {
      "type": "string",
      "maxLength": 1000000,
      "default": "",
      "description": "Plain text input. File tools use files instead unless otherwise documented."
    },
    "options": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "crop": {
          "type": "boolean",
          "description": "Automatically detect and crop page edges",
          "default": true
        }
      }
    },
    "files": {
      "type": "array",
      "maxItems": 20,
      "items": {
        "type": "object",
        "required": [
          "name",
          "base64"
        ],
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 200,
            "description": "Filename only, no path."
          },
          "mime": {
            "type": "string",
            "maxLength": 150
          },
          "bytes": {
            "type": "integer",
            "minimum": 0,
            "description": "Optional decoded byte count; must match content if supplied."
          },
          "base64": {
            "type": "string",
            "contentEncoding": "base64",
            "description": "File bytes as padded base64. Use the tool-specific limits.files_bytes value for the total decoded input size."
          }
        }
      }
    }
  }
}
```

#### Complete output schema

```json
{
  "type": "object",
  "required": [
    "tool",
    "result"
  ],
  "properties": {
    "tool": {
      "type": "string"
    },
    "result": {
      "type": "object",
      "required": [
        "text",
        "files"
      ],
      "properties": {
        "text": {
          "type": [
            "string",
            "null"
          ]
        },
        "data": {
          "description": "Parsed JSON when the textual result is JSON."
        },
        "name": {
          "type": "string"
        },
        "mime": {
          "type": "string"
        },
        "files": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "name",
              "mime",
              "bytes",
              "base64"
            ],
            "properties": {
              "name": {
                "type": "string"
              },
              "mime": {
                "type": "string"
              },
              "bytes": {
                "type": "integer"
              },
              "base64": {
                "type": "string",
                "contentEncoding": "base64"
              }
            }
          }
        }
      }
    }
  }
}
```

#### Error and retry handling

Failures return a non-200 status and `error.code` plus `error.message`. Correct invalid input before retrying; retry server-busy responses with bounded backoff. Returned files contain Base64 data, not persistent download URLs. Decode and inspect the output before treating conversion as successful. See the shared API guide for the complete status and timeout rules.

### Browser-agent workflow

1. Open the human page in a browser that supports WebMCP.
2. Discover the interface exposed by that page; use its actual schema.
3. Select files on the page first when the tool requires files.
4. Call `run_current_tool` with valid input and settings.
5. Inspect the returned result or error and the displayed output. Retrieve files from the displayed download links.

Calls do not automatically copy or download results. Browser permissions still apply. Interface availability alone is not proof of successful execution.

### Planning specification

Camera capture, corner correction and page ordering; optional OCR is a separate step.

This describes intended requirements. Use the implementation notes, interface schema and observed output to determine current support.

### Complete machine-readable capability record

```json
{
  "id": "scan-to-pdf",
  "category": "pdf-tools",
  "built": true,
  "requirements": "Camera capture, corner correction and page ordering; optional OCR is a separate step.",
  "implementation": {
    "fields": [
      {
        "key": "crop",
        "label": "Automatically detect and crop page edges",
        "value": true,
        "type": "checkbox"
      }
    ],
    "files": true,
    "accept": ".png,.jpg,.jpeg,.webp",
    "multiple": true,
    "input": false,
    "processing": "Server required",
    "native": true,
    "maxFileBytes": 20971520,
    "note": "Processed by the local, self-hosted engine. No third-party conversion service is used. Upload photos or scans in page order. Automatic perspective correction works best with a clear page border. Review the exported PDF. Direct camera capture is not included yet.",
    "experience": {
      "automatic": false,
      "single": false,
      "label": "Your text",
      "placeholder": "Type or paste your input…",
      "help": "Up to 1,000,000 characters. Review the settings before running.",
      "action": "Convert file"
    },
    "mode": "explicit",
    "interactive": false
  },
  "execution": "POST /api/v1/tools/scan-to-pdf/run",
  "api": {
    "id": "scan-to-pdf",
    "name": "Scan to PDF",
    "category": "pdf-tools",
    "description": "Combine document photos into a PDF with automatic page detection.",
    "notes": "Processed by the local, self-hosted engine. No third-party conversion service is used. Upload photos or scans in page order. Automatic perspective correction works best with a clear page border. Review the exported PDF. Direct camera capture is not included yet.",
    "human_path": "/en/pdf-tools/scan-to-pdf/",
    "method": "POST",
    "endpoint": "/api/v1/tools/scan-to-pdf/run",
    "schema_url": "/api/v1/tools/scan-to-pdf",
    "input_schema": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "input": {
          "type": "string",
          "maxLength": 1000000,
          "default": "",
          "description": "Plain text input. File tools use files instead unless otherwise documented."
        },
        "options": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "crop": {
              "type": "boolean",
              "description": "Automatically detect and crop page edges",
              "default": true
            }
          }
        },
        "files": {
          "type": "array",
          "maxItems": 20,
          "items": {
            "type": "object",
            "required": [
              "name",
              "base64"
            ],
            "additionalProperties": false,
            "properties": {
              "name": {
                "type": "string",
                "maxLength": 200,
                "description": "Filename only, no path."
              },
              "mime": {
                "type": "string",
                "maxLength": 150
              },
              "bytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Optional decoded byte count; must match content if supplied."
              },
              "base64": {
                "type": "string",
                "contentEncoding": "base64",
                "description": "File bytes as padded base64. Use the tool-specific limits.files_bytes value for the total decoded input size."
              }
            }
          }
        }
      }
    },
    "output_schema": {
      "type": "object",
      "required": [
        "tool",
        "result"
      ],
      "properties": {
        "tool": {
          "type": "string"
        },
        "result": {
          "type": "object",
          "required": [
            "text",
            "files"
          ],
          "properties": {
            "text": {
              "type": [
                "string",
                "null"
              ]
            },
            "data": {
              "description": "Parsed JSON when the textual result is JSON."
            },
            "name": {
              "type": "string"
            },
            "mime": {
              "type": "string"
            },
            "files": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "name",
                  "mime",
                  "bytes",
                  "base64"
                ],
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "mime": {
                    "type": "string"
                  },
                  "bytes": {
                    "type": "integer"
                  },
                  "base64": {
                    "type": "string",
                    "contentEncoding": "base64"
                  }
                }
              }
            }
          }
        }
      }
    },
    "processing": "Server; self-hosted native engine, no external conversion service",
    "limits": {
      "request_bytes": 31457280,
      "input_characters": 1000000,
      "files_bytes": 20971520,
      "max_files": 20,
      "timeout_seconds": 90
    }
  },
  "agent_processing": "Server; self-hosted native engine, no external conversion service",
  "browser_agent": {
    "supported": true,
    "name": "run_current_tool",
    "discovery": "WebMCP on the human page in a supporting browser",
    "verification": "See audit/API-AUDIT.md; availability is not verification"
  }
}
```

## Page guide

Combine document photos into a PDF with automatic page detection.

## How to use Scan to PDF

1. Choose one or more files in PNG, JPEG or WEBP.
2. Review the settings, then choose Convert file.
3. Review the result, then use Copy result or a download link when available.

## What to expect

Combine document photos into a PDF with automatic page detection. Processed by the local, self-hosted engine. No third-party conversion service is used. Upload photos or scans in page order. Automatic perspective correction works best with a clear page border. Review the exported PDF. Direct camera capture is not included yet.
