Important: This document is for the beta version of the new Pdfcrowd API. Use this documentation for the stable API version.

PDF to PDF API - HTTP Documentation

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 it can be application/x-www-form-urlencoded too.

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

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. You can find the API key in your account page.

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

Server Address

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

Both HTTP and HTTPS protocols are supported.

Getting Started

Join 4 local PDF files together to a PDF file

curl -f -u 'username: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/

PDF to PDF API Reference

Conversion Format

Parameter Description Default
input_format
The format of input file.
Allowed values:
  • pdf

 

PDF Manipulation

Parameter Description Default
action
Specifies the action to be performed on the input PDFs.
Allowed values:
  • join
    Concatenate input PDFs into a single one.
  • shuffle
    Collate pages from input PDFs into a single one, take one page at a time from each input PDF. This is useful when combining two scanned documents containing odd and even pages.
join

 

Response

Parameter Description Default
output_name
The file name of the created file (max 180 chars). If not specified then the name is auto-generated.
content_disposition
The value of the Content-Disposition HTTP header sent in the response.
Allowed values:
  • attachment
    Forces the browser to pop up a Save As dialog.
  • inline
    The browser will open the result file in the browser window.
attachment

 

Miscellaneous

Parameter Description Default
debug_log
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.
Allowed values:
  • true, 1 or on
  • false, 0 or off
false

 

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