PDF to HTML with HTTP POST

Overview

The Pdfcrowd API is HTTP-based, the communication is made through normal HTTP requests. You can call the API by sending an HTTP request to the API server address with options passed as POST data.

The POST request's content type must be multipart/form-data if the request includes any local files. Otherwise application/x-www-form-urlencoded can be used as well.

You can also check out our API client libraries if you want to implement the API in your favorite programming language.

Samples

Authentication

Authentication is needed in order to use the Pdfcrowd API. The credentials used for accessing the API are your Pdfcrowd username and the API key.

The authentication method for user credentials is HTTP Basic Access Authentication. You provide your credentials every time you make a request.

You can try out the API without registration using the following demo credentials:
  • Username: demo
  • API key: ce544b6ea52a5621fb9d55f8b542d14d

To get your personal API credentials, you can start a free API trial or buy the API license.

Server Address

The server address is https://api.pdfcrowd.com/convert/20.10/

Other addresses can be used:

  • https://api.pdfcrowd.com/convert/latest/ is for the latest converter version.
  • https://api.pdfcrowd.com/convert/20.10/ is for version 20.10.

Both HTTP and HTTPS protocols are supported.

Examples

curl -f -u "demo:ce544b6ea52a5621fb9d55f8b542d14d" \
    -o "logo.html" \
    -F "input_format=pdf" \
    -F "output_format=html" \
    -F "file=@/path/to/logo.pdf" \
    https://api.pdfcrowd.com/convert/20.10/
curl -f -u "demo:ce544b6ea52a5621fb9d55f8b542d14d" \
    -o "invoice.html" \
    -F "input_format=pdf" \
    -F "output_format=html" \
    -F "url=https://pdfcrowd.com/static/pdf/apisamples/invoice.pdf" \
    https://api.pdfcrowd.com/convert/20.10/

Response Headers

HTTP response can contain the following headers.
You can find details about each conversion in your conversion log.

Name Description
X-Pdfcrowd-Debug-Log URL to the debug log
X-Pdfcrowd-Remaining-Credits the number of available conversion credits in your account
X-Pdfcrowd-Consumed-Credits the number of credits consumed by the conversion
X-Pdfcrowd-Job-Id the unique ID of the conversion
X-Pdfcrowd-Pages the total number of pages in the output document
X-Pdfcrowd-Output-Size the size of the output in bytes

Troubleshooting

  • List of API Status Codes if an error code is returned.
  • You can use debug_log to get detailed info about the conversion, such as conversion errors, time, console output.
  • Take a look at the FAQ section.
  • Are you missing a feature? Contact us, we look forward to your suggestions.

POST Parameter Reference

Refer for details to the POST Parameter Reference.