PDF to TXT API

Convert textual and scanned PDF document to a plain text file, extract text from PDF, apply OCR on a scanned PDF document before conversion.

API Request:

Copy parameter's URL Secret Secret
Optional

String Authentication secret must be provided as a query parameter. If omitted, token must be provided.

Show all

Copy parameter's URL Token Token
Optional

String Authentication token must be provided as a query parameter. If omitted, secret must be provided.

Show all

Copy parameter's URL File File
Required

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

Show all

Copy parameter's URL StoreFile Store file
Optional

Bool Store converted file on our secure server and provides download URL.

Default: False

Show all

Copy parameter's URL FileName File name
Optional

String Converted output file name without extension. The extension will be added automatically.

Show all

Copy parameter's URL Timeout Timeout
Optional

Integer Conversion timeout in seconds.

Default: 600

Range: 10 .. 1200

Show all

Copy parameter's URL Async Asynchronous
Optional

Bool Run conversion job asynchronously.

Default: False

Show all

Copy parameter's URL JobId Job ID
Optional

String Conversion job self generated UUID (RFC 4122) used for getting conversion result asynchronously. Also automatically added to WebHook url.

Show all

Copy parameter's URL WebHook WebHook
Optional

String Set WebHook URL to call after conversion is finished. Also works for synchronous requests.

Show all

Copy parameter's URL Password Open Password
Optional

String Sets the password to open protected documents.

Show all

Copy parameter's URL PageRange Page Range
Optional

String Set page range. Example 1-10 or 1,2,5.

Default: 1-2000

Show all

Copy parameter's URL OcrLanguage OCR Language
Optional

Collection Set the OCR language. Ask support to add your language if missing.

Default: en

Values: ca, da, de, es, en, he, pl, pt, ru, sv, tr, lt

Show all

Copy parameter's URL EnableOcr Enable OCR
Optional

Bool Enable optical character recognition(OCR).

Default: False

Show all

Copy parameter's URL IncludeFormatting Include Formatting
Optional

Bool Persist formatting while extracting text.

Default: False

Show all

Copy parameter's URL IncludeInvisibleText Include invisible text
Optional

Bool Include invisible text where text and background colors are the same and OCR layer.

Default: False

Show all

Show parameters

Snippets are autogenerated according to converter parameter choices above. Please select file in "File" or "Files" parameter before using code snippets.

Code snippet is using ConvertAPI JavaScript Client

Code snippet is using ConvertAPI Node.js Client

Code snippet is using ConvertAPI PHP Client

Code snippet is using ConvertAPI Java Client

Code snippet is using ConvertAPI C# Client

Code snippet is using ConvertAPI Ruby Client

Code snippet is using ConvertAPI Python Client

Code snippet is using ConvertAPI Go Client

Code snippet is using command line utility program

For conversions with the multiple file result please refer to the example