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 it can
You can also check out our API client libraries if you want to implement the API in your favorite programming language.
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. You can sign up for the Pdfcrowd API here.
The authentication method for user credentials is HTTP Basic Access Authentication. You provide your credentials every time you make a request.
The server address is
Both HTTP and HTTPS protocols are supported.
curl -f -u "your_username:your_apikey" \ -o offer.pdf \ -F "input_format=pdf" \ -F "f_1=@/path/to/cover.pdf" \ -F "f_2=@/path/to/proposal.pdf" \ -F "f_3=@/path/to/price.pdf" \ -F "f_4=@/path/to/contact.pdf" \ https://api.pdfcrowd.com/convert/
Specifies the action to be performed on the input PDFs.
The file name of the created file (max 180 chars). If not specified then the name is auto-generated.
The value of the Content-Disposition HTTP header sent in the response.
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log is returned in the X-Pdfcrowd-Debug-Log response header or available in conversion statistics.
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
HTTP response can contain the following headers.
You can find details about each conversion in your conversion log.
|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|