PDF tools

Inspect a PDF

Page count, page sizes and whether the file is encrypted or carries forms. Free — no credit is spent.

With for: edit it also returns what an editor recipe needs: a stable id for every page (p0, p1, …) with its size and rotation, and the document's form fields. That mode refuses documents over 200 pages and needs a plan that includes the editor.

post/pdf/inspect

Request

  • Base URL: https://api.podpdf.com
  • URL: https://api.podpdf.com/pdf/inspect
  • Auth: API key in header X-API-Key

Request body

s3_keystring

Key from /pdf/upload-url (up to 150 MB).

filenamestring
for'edit'

Add page ids, geometry and form fields for the editor.

Example request

{
  "input": {
    "filename": "contract.pdf"
  }
}

Response

What the file contains

filenamestring nullable
size_bytesinteger
page_countinteger nullable

null for an encrypted file.

encryptedboolean
has_formsboolean nullable
has_signaturesboolean nullable
has_xfaboolean
warningsstring[]
max_pagesinteger

The page limit for the path this file would take.

Example response

{
  "pages": [
    {
      "id": "p0"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.