PDF to JPG

`POST /v1/pdf/convert/to/jpg`

Attributes

Attributes are case-sensitive and should be inside JSON for POST request. for example: { "url": "https://example.com/file1.pdf" }

Attribute	Type	Required	Default	Description
`url`	string	Yes	-	URL to the source file `url` attribute
`callback`	string	No	-	The callback URL (or Webhook) used to receive the POST data. see Webhooks & Callbacks. This is only applicable when `async` is set to `true`.
`httpusername`	string	No	-	HTTP auth user name if required to access source URL.
`httppassword`	string	No	-	HTTP auth password if required to access source URL.
`pages`	string	No	all pages	Specify page indices as comma-separated values or ranges to process (e.g. “0, 1, 2-” or “1, 2, 3-7”). The first-page index is 0. Use ”!” before a number for inverted page numbers (e.g. “!0” for the last page). If not specified, the default configuration processes all pages. The input must be in string format.
`rect`	string	No	-	Defines coordinates for extraction. Use`PDF Edit Add Helper`to get or measure PDF coordinates. The format is `{x} {y} {width} {height}`.
`lang`	string	No	eng	Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. see Language Support. You can also use 2 languages simultaneously like this: `eng+deu` (any combination).
`inline`	boolean	No	`false`	Set to true to return results inside the response. Otherwise, the endpoint will return a URL to the output file generated.
`password`	string	No	-	Password for the PDF file.
`async`	boolean	No	`false`	Set `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
`name`	string	No	-	File name for the generated output, the input must be in string format.
`expiration`	integer	No	`60`	Set the expiration time for the output link in minutes. After this specified duration, any generated output file(s) will be automatically deleted from PDF.co Temporary Files Storage. The maximum duration for link expiration varies based on your current subscription plan. To store permanent input files (e.g. re-usable images, pdf templates, documents) consider using PDF.co Built-In Files Storage.
`profiles`	object	No	-	See Profiles for more information.
`outputDataFormat`	string	No	-	If you require your output as `base64` format, set this to `base64`
`RotationAngle`	integer	No	-	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`.
`RenderTextObjects`	boolean	No	`true`	Controls whether to render text objects in the PDF document. When set to true, it will render all text objects in the PDF document. Set to false to skip over text objects during rendering. See Disable Text Layer for more information.
`RenderImageObjects`	boolean	No	`true`	Render image objects or not
`RenderVectorObjects`	boolean	No	`true`	Render vector objects or not
`RenderCurveVectorObjects`	boolean	No	`true`	Render curve vector objects or not
`TextSmoothingMode`	string	No	-	Controls text smoothing mode. Available options: `HighSpeed`, `HighQuality`.
`VectorSmoothingMode`	string	No	-	Controls vector smoothing mode. Available options: `HighSpeed`, `HighQuality`.
`ImageInterpolationMode`	string	No	-	Controls image interpolation mode. Available options: `HighSpeed`, `HighQuality`.
`JPEGQuality`	integer	No	80	Range from `0` (lowest) to `100` (highest), default is `80`. See profiles.JPEGQuality
`TIFFCompression`	string	No	-	Controls TIFF compression. Available options: `None`, `LZW`, `CCITT3`, `CCITT4`, `RLE`.
`RotateFlipType`	string	No	-	Controls rotation and flip type. Available options: `RotateNoneFlipNone`, `Rotate90FlipNone`, `Rotate180FlipNone`, `Rotate270FlipNone`, `RotateNoneFlipX`, `Rotate90FlipX`, `Rotate180FlipX`, `Rotate270FlipX`, `RotateNoneFlipY`, `Rotate90FlipY`, `Rotate180FlipY`, `Rotate270FlipY`, `RotateNoneFlipXY`, `Rotate90FlipXY`, `Rotate180FlipXY`, `Rotate270FlipXY`.
`ImageBitsPerPixel`	string	No	-	Controls image bits per pixel. Available options: `BPP1`, `BPP8`, `BPP24`, `BPP32`.
`OneBitConversionAlgorithm`	string	No	-	Controls one-bit conversion algorithm. Available options: `BayerOrderedDithering`, `OtsuThreshold`.
`FontHintingMode`	string	No	-	Controls font hinting mode. Available options: `Default`, `Stronger`.
`ResolutionOverride`	float	No	-	Overrides the default resolution. Specified in DPI.
`NightMode`	boolean	No	`false`	Enables night mode rendering.
`RenderingResolution`	integer	No	120	See Set Image Resolution for more information.
`DataEncryptionAlgorithm`	string	No	-	Controls the encryption algorithm used for data encryption. See User-Controlled Encryption for more information. The available algorithms are: `AES128`, `AES192`, `AES256`.
`DataEncryptionKey`	string	No	-	Controls the encryption key used for data encryption. See User-Controlled Encryption for more information.
`DataEncryptionIV`	string	No	-	Controls the encryption IV used for data encryption. See User-Controlled Encryption for more information.
`DataDecryptionAlgorithm`	string	No	-	Controls the decryption algorithm used for data decryption. See User-Controlled Encryption for more information. The available algorithms are: `AES128`, `AES192`, `AES256`.
`DataDecryptionKey`	string	No	-	Controls the decryption key used for data decryption. See User-Controlled Encryption for more information.
`DataDecryptionIV`	string	No	-	Controls the decryption IV used for data decryption. See User-Controlled Encryption for more information.

Disable Text Layer

We can turn off the text layer for our render as follows:

{
 "profiles": "{ 'RenderTextObjects': false }"
}

Set Image Resolution

By default the screen resolution is 120 DPI. To change the rendering resolution, please use:

{
 "profiles": "{ 'RenderingResolution': 300 }"
}

`JPEGQuality`

To set image quality (from 0 (lowest) to 100 (highest), default is 80) please use:

{
 "profiles": "{ 'JPEGQuality': 75 }"
}

Use this parameter to set additional configurations for fine-tuning and extra options. Explore the Profiles section for more.

Profiles section for more.

{
 "profiles": "{
    'RenderTextObjects': false,
    'RenderVectorObjects': true,
    'RenderImageObjects': true
  }"
}

`OCRImagePreprocessingFilters`

To set image preprocessing filters, please use:

{
 "profiles": "{
    "OCRImagePreprocessingFilters.AddGrayscale()": [],
    "OCRImagePreprocessingFilters.AddGammaCorrection()": [
        1.4
    ]
}"
}

Query parameters

No query parameters accepted.

Responses

Parameter	Type	Description
`urls`	array[string]	List of URLs to the final PDF file stored in S3.
`outputLinkValidTill`	string	Timestamp indicating when the output link will expire
`pageCount`	integer	Number of pages in the PDF document.
`error`	boolean	Indicates whether an error occurred (`false` means success)
`status`	string	Status code of the request (200, 404, 500, etc.). For more information, see Response Codes.
`name`	string	Name of the output file
`credits`	integer	Number of credits consumed by the request
`remainingCredits`	integer	Number of credits remaining in the account
`duration`	integer	Time 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-to-image/sample.pdf",
  "inline": true,
  "pages": "0-",
  "async": false
}

`Example` Response

To see the main response codes, please refer to the Response Codes page.

{
  "urls": [
    "https://pdf-temp-files.s3.amazonaws.com/c15b8d82e0034d01a73eac719d69349b/sample.png",
    "https://pdf-temp-files.s3.amazonaws.com/152d2fe414b645e38f81a49e5dafa85b/sample.png"
  ],
  "pageCount": 2,
  "error": false,
  "status": 200,
  "name": "sample.png",
  "duration": 1121,
  "remainingCredits": 98722216,
  "credits": 30
}

Inconsistent URL Encoding in cURL Output: When using cURL to make API requests, the output JSON may show URL characters encoded as Unicode escape sequences. For example, the ampersand character (&) may appear as \u0026 in the cURL output. This is normal JSON encoding behavior and does not affect the validity of the URL. The URL will function correctly when used, as JSON parsers automatically decode these escape sequences. If you’re parsing the response programmatically, your JSON parser will handle this conversion automatically.

Code Samples

CURL
JavaScript/Node.js
Python
C#
Java
PHP

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

Welcome

Extraction

Editing

PDF Conversion

Excel Conversion

PDF Merging & Splitting

Forms

Find & Search

Document, File & System

Pages

Barcodes

Glossary

`POST /v1/pdf/convert/to/jpg`

Attributes

Disable Text Layer

Set Image Resolution

`JPEGQuality`

Use this parameter to set additional configurations for fine-tuning and extra options. Explore the Profiles section for more.

`OCRImagePreprocessingFilters`

Query parameters

Responses

`Example` Payload

`Example` Response

Code Samples

Welcome

Extraction

Editing

PDF Conversion

Excel Conversion

PDF Merging & Splitting

Forms

Find & Search

Document, File & System

Pages

Barcodes

Glossary

​POST /v1/pdf/convert/to/jpg

​Attributes

​Disable Text Layer

​Set Image Resolution

​JPEGQuality

​Use this parameter to set additional configurations for fine-tuning and extra options. Explore the Profiles section for more.

​OCRImagePreprocessingFilters

​Query parameters

​Responses

​Example Payload

​Example Response

​Code Samples

`POST /v1/pdf/convert/to/jpg`

Attributes

Disable Text Layer

Set Image Resolution

`JPEGQuality`

Use this parameter to set additional configurations for fine-tuning and extra options. Explore the Profiles section for more.

`OCRImagePreprocessingFilters`

Query parameters

Responses

`Example` Payload

`Example` Response

Code Samples