Extract PDF API

File to be converted. Value can be URL or file content.

Sets the password to open protected PDF.

The DocumentType parameter specifies the type of document you're processing, enabling the AI to precisely extract structured data based on the selected document category. Selecting the correct document type improves extraction accuracy by applying optimized data extraction rules tailored for each category. Choose manual if you prefer to exclusively define CustomExtractionData parameter.

Select the DocumentType that matches your document:

• Auto - Attempts to identify the document as one of the listed types and applies the corresponding extraction rules.

• Invoice - Extract structured data from invoices, including invoice number, dates, totals, vendor details, and line items.

• Receipt - Optimized extraction for payment receipts, capturing dates, totals, vendor details, and payment methods.

• Contract - Captures critical details from contracts or agreements, including parties involved, dates, terms, and conditions.

• Identification - Designed for identification documents like passports, driver's licenses, or national ID cards, extracting names, dates, document numbers, and other identifying information.

• Financial - Specifically targets financial documents, including bank statements and transaction records, extracting transaction dates, amounts, balances, and descriptions.

• Form - Extracts structured data from standard forms containing predefined fields, ideal for surveys, applications, and questionnaires.

• Manual - Disables predefined AI document extraction presets. Only manually configured extraction parameters are used, giving full control to the user.

A JSON array defining specific values to extract.

Example JSON

[
  {
    "FieldName": "TotalResult",
    "Extract": "total price"
  },
  {
    "FieldName": "ServiceName",
    "Extract": "most expensive service name"
  }
]

Sets the minimum confidence threshold for AI-based detection of sensitive data. Higher values reduce false positives but may miss subtle matches.

When the StoreFile parameter is set to True, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.

When StoreFile is set to False, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.