POST /v1/pdf/info

Extracts basic information about an input PDF file, PDF file security permissions, and other information. If you want to extract information about fillable fields (checkboxes, radiobuttons, listboxes) from PDF then please use /pdf/info/fields instead.

For one-time check of PDF file information and find form fields please use PDF Edit Add Helper.

Attributes

Attributes are case-sensitive and should be inside JSON for POST request. for example: { "url": "https://example.com/file1.pdf" }
AttributeTypeRequiredDefaultDescription
urlstringYes-URL to the source file url attribute
callbackstringNo-The callback URL (or Webhook) used to receive the POST data. see Webhooks & Callbacks. This is only applicable when async is set to true.
httpusernamestringNo-HTTP auth user name if required to access source URL.
httppasswordstringNo-HTTP auth password if required to access source URL.
passwordstringNo-Password for the PDF file.
asyncbooleanNofalseSet async to true for long processes to run in the background, API will then return a jobId which you can use with the Background Job Check endpoint. Also see Webhooks & Callbacks
profilesobjectNo-See Profiles for more information.
    OCRModestringNoAutoSpecifies how OCR (Optical Character Recognition) should process input content, offering various modes to tailor text extraction based on content type such as images, fonts, and vector graphics. For more information, see OCR Extraction Modes.
    OCRResolutionintegerNo300Use this parameter to change the OCR resolution from the default 300 dpi. The range is from 72 to 1200 dpi.
    RotationAngleintegerNo-Use manual rotation to handle PDFs with vertically drawn text. Normally, OCR automatically detects page rotation in PDFs and extracts text accurately. However, in some cases, the PDF might not have an actual rotated page --- Rather, the text itself is drawn vertically. In such scenarios, auto-detection may fail. You can use this parameter to manually set the page rotation. The available angles are: 0, 1, 2, 3.
    LineGroupingModestringNoNoneControls line grouping in PDF text extraction. Modes: None (no grouping), GroupByRows (merge rows if all cells align), GroupByColumns (merge cells by column), JoinOrphanedRows (merge single-cell rows to above if no separator).
    ConsiderFontColorsbooleanNofalseControls whether font colors should be considered when detecting table structure and merging text objects during PDF extraction. Set to true to consider font colors.
    DetectNewColumnBySpacesRatiostringNo1.2Controls how spaces between words are interpreted for column detection in PDF text extraction. It defines the ratio of space width that determines when text should be treated as being in separate columns.
    AutoAlignColumnsToHeaderbooleanNotrueControls how columns are detected and aligned during table extraction from PDF documents. It affects both table structure detection and text extraction with formatting preservation. Set to true to automatically align columns to the header row. When set to true (default), the row with the most columns is used as the header, and all other rows are aligned to this structure --- ideal for well-structured tables. When set to false, columns are analyzed independently across all rows to build the structure, which works better for inconsistent or irregular tables.
    OCRImagePreprocessingFilters.AddGammaCorrection()array[string (float format)]No["1.4"]Adds a gamma correction filter to the image preprocessing pipeline used during OCR (Optical Character Recognition). This filter adjusts the brightness and contrast of an image by applying a non-linear gamma correction to improve text recognition quality.
    OCRImagePreprocessingFilters.AddGrayscale()booleanNofalseSet to true to preprocessing filter that converts a colored document/image to grayscale before performing OCR
    DataEncryptionAlgorithmstringNo-Controls the encryption algorithm used for data encryption. See User-Controlled Encryption for more information. The available algorithms are: AES128, AES192, AES256.
    DataEncryptionKeystringNo-Controls the encryption key used for data encryption. See User-Controlled Encryption for more information.
    DataEncryptionIVstringNo-Controls the encryption IV used for data encryption. See User-Controlled Encryption for more information.
    DataDecryptionAlgorithmstringNo-Controls the decryption algorithm used for data decryption. See User-Controlled Encryption for more information. The available algorithms are: AES128, AES192, AES256.
    DataDecryptionKeystringNo-Controls the decryption key used for data decryption. See User-Controlled Encryption for more information.
    DataDecryptionIVstringNo-Controls the decryption IV used for data decryption. See User-Controlled Encryption for more information.

Query parameters

No query parameters accepted.

Responses

ParameterTypeDescription
infoobjectInfo details.
errorbooleanIndicates whether an error occurred (false means success)
statusstringStatus code of the request (200, 404, 500, etc.). For more information, see Response Codes.
creditsintegerNumber of credits consumed by the request
remainingCreditsintegerNumber of credits remaining in the account
durationintegerTime taken for the operation in milliseconds

Example Payload

To see the request size limits, please refer to the Request Size Limits.
{
  "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-info/sample.pdf",
  "async": false
}

Example Response

To see the main response codes, please refer to the Response Codes page.
{
  "info": {
    "PageCount": 1,
    "Author": "Alice V. Knox",
    "Title": "Kid's News 1",
    "Producer": "Acrobat Distiller 4.0 for Windows",
    "Subject": "Kid's News 1",
    "CreationDate": "8/15/2001 2:50:36 PM",
    "Bookmarks": "",
    "Keywords": "",
    "Creator": "Adobe PageMaker 6.52",
    "Encrypted": false,
    "PageRectangle": {
      "Location": {
        "IsEmpty": true,
        "X": 0,
        "Y": 0
      },
      "Size": "612, 792",
      "X": 0,
      "Y": 0,
      "Width": 612,
      "Height": 792,
      "Left": 0,
      "Top": 0,
      "Right": 612,
      "Bottom": 792,
      "IsEmpty": false
    },
    "ModificationDate": "9/20/2001 6:23:02 PM",
    "EncryptionAlgorithm": 0,
    "PermissionPrinting": true,
    "PermissionModifyDocument": true,
    "PermissionContentExtraction": true,
    "PermissionModifyAnnotations": true,
    "PermissionFillForms": true,
    "PermissionAccessibility": true,
    "PermissionAssemble": true,
    "PermissionHighQualityPrint": true
  },
  "error": false,
  "status": 200,
  "remainingCredits": 77732
}

Code Samples

curl --location --request POST 'https://api.pdf.co/v1/pdf/info' \
--header 'x-api-key: *******************' \
--header 'Content-Type: application/json' \
--data-raw '{
"url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-info/sample.pdf",
"async": false
}'