PDF to PDF in Ruby

This page describes how to use the Pdfcrowd online API to join multiple PDF files or update PDF attributes in Ruby. The API is user-friendly and can be integrated into your application with just a few lines of code.


You can install the client library from rubygems.org
gem install pdfcrowd

Check out other installation options.

Quick Start

Here are Ruby examples for quickly getting started with the API. See more examples.


The credentials to access the API are your Pdfcrowd username and the API key. You can try out the API without registering 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.

Error Handling

It is recommended that you implement error handling to catch errors that the API may return, see the example code below. A list of status codes and their description can be found here.

    # call the API 
rescue Pdfcrowd::Error => why 
    # print the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # print the error code
    STDERR.puts "Pdfcrowd Error Code: #{why.getCode()}"

    # print the error message
    STDERR.puts "Pdfcrowd Error Message: #{why.getMessage()}"


  • Refer to the API Status Codes page if the API returns an error.
  • You can use setDebugLog and getDebugLogUrl to get detailed info about the conversion, such as load errors, load times, browser console output, etc.
  • Check the FAQ.
  • Contact us if you need help or are missing a feature.

API Method Reference

Refer to the PDF to PDF Ruby Reference for a description of all API methods.