PDF to Text in Ruby

This page describes how to use our cloud-based API to convert PDF to text in Ruby. The API is user-friendly and can be integrated into your application with just a few lines of code.

Installation

The Ruby API client library provides easy access to the Pdfcrowd API. No third-party libraries are required.

Install the client library from rubygems.org
gem install pdfcrowd

We also offer other installation options.

Authentication

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.

API Method Reference

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

Code Examples

Here are a few Ruby examples to get you started quickly with the API. See more examples.

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::PdfToTextClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # run the conversion and write the result to a file
    client.convertFileToFile("/path/to/invoice.pdf", "invoice.txt")
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end
require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::PdfToTextClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # run the conversion and write the result to a file
    client.convertUrlToFile("https://pdfcrowd.com/static/pdf/apisamples/invoice.pdf", "invoice.txt")
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end
require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::PdfToTextClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # run the conversion and write the result to a file
    client.convertRawDataToFile(open('/path/to/hello_world.pdf', 'rb').read(), "invoice.txt")
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Troubleshooting