PDF.co Web API (Application Programming Interface)

Get Your Free API Key

Supported Formats

json

Supported Formats

json

Errors

Code Description
400 bad input parameters
401 unauthorized
403 not enough credits
405 Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info

Params

Param name Description
async
optional

Runs processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)

  • Must be one of: true, false.

encrypt
optional

Enable encryption for output file.

  • Must be one of: true, false.

file
optional

Source PDF file.

url
optional

URL of the source PDF file.

  • Must be a String

name
optional

File name for generated output.

  • Must be a String

worksheetIndex
optional
  • Must be a String

Supported Formats

json

Errors

Code Description
400 bad input parameters
401 unauthorized
403 not enough credits
405 Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info

Params

Param name Description
async
optional

Runs processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)

  • Must be one of: true, false.

encrypt
optional

Enable encryption for output file.

  • Must be one of: true, false.

file
optional

Source PDF file.

url
optional

URL of the source PDF file.

  • Must be a String

name
optional

File name for generated output.

  • Must be a String

Supported Formats

json

Errors

Code Description
400 bad input parameters
401 unauthorized
403 not enough credits
405 Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info

Params

Param name Description
async
optional

Runs processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)

  • Must be one of: true, false.

encrypt
optional

Enable encryption for output file.

  • Must be one of: true, false.

file
optional

Source PDF file.

url
optional

URL of the source PDF file.

  • Must be a String

name
optional

File name for generated output.

  • Must be a String

Supported Formats

json

Errors

Code Description
400 bad input parameters
401 unauthorized
403 not enough credits
405 Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info

Params

Param name Description
async
optional

Runs processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)

  • Must be one of: true, false.

templatedata
optional

JSON model which will be used for processing HTML template

  • Must be a String

encrypt
optional

Enable encryption for output file.

  • Must be one of: true, false.

html
required

HTML code.

  • Must be a String

name
optional

File name for generated output.

  • Must be a String

Supported Formats

json

Errors

Code Description
400 bad input parameters
401 unauthorized
403 not enough credits
405 Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info

Params

Param name Description
async
optional

Runs processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)

  • Must be one of: true, false.

encrypt
optional

Enable encryption for output file.

  • Must be one of: true, false.

file
optional

Source PDF file.

url
optional

URL of the source PDF file.

  • Must be a String

name
optional

File name for generated output.

  • Must be a String

GET/POST - https://api.pdf.co/v1/pdf/convert/from/url
URL of the web page to be saved as PDF document.

Supported Formats

json

Errors

Code Description
400 bad input parameters
401 unauthorized
403 not enough credits
405 Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info

Params

Param name Description
async
optional

Runs processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)

  • Must be one of: true, false.

templatedata
optional

JSON model which will be used for processing HTML template

  • Must be a String

encrypt
optional

Enable encryption for output file.

  • Must be one of: true, false.

url
required

URL of the web page to be saved as PDF document.

  • Must be a String

name
optional

File name for generated output.

  • Must be a String