View all our articles

Generate a document with full height in Ruby with Faraday

In this guide, we'll show you how to generate a document with full height dynamically using Ruby and the Faraday library to convert them to PDF using PDFShift's API.

When you're converting a document, you might want to generate a document with full height dynamically. This can be done by setting the format parameter to the request and passing it a custom "auto" value for the {height} part.

require 'faraday'
require 'json'

# You can get an API key at
api_key = 'sk_xxxxxxxxxxxx'

params = {
    'source' => '',
    'format' => '1280xauto'

# Create a Faraday connection
conn = "") do |faraday|
    faraday.request :url_encoded
    faraday.adapter Faraday.default_adapter

# Make the POST request
response = do |req|
    req.headers['Content-Type'] = 'application/json'
    req.headers['Authorization'] = "Basic #{Base64.strict_encode64("api:#{api_key}")}"
    req.body = params.to_json

# Check for successful response
unless response.success?
    raise "Request failed with status code #{response.status}: #{response.body}"

# write response to a file nammed "result.pdf"'result.pdf', 'wb') { |f| f.write(response.body) }

# Print a success message
puts 'The PDF document was generated and saved to result.pdf'

The format parameter can accept various values, such as 'Letter', 'Legal', 'Tabloid', 'Ledger', 'A0', 'A1', 'A2', 'A3', 'A4', 'A5'.

But it can also accept a custom values that is defined per the width and height as follow: {width}x{height}

Both width and height are pixel value by default, but if you precise the unit (in "cm", "mm", "in" or "pt"). That unit will be used instead.

For instance, you can set a format of:

    "source": "",
    "format": "21cmx29,7cm"

Now, if you want a "liquid" height, which will analyze the height of the page and use it as your format, you can set the {height} value to auto. So, instead of setting a fixed height such as 'format': '1280x1024', you can set 'format': '1280xauto' and the height will be calculated based on the content of the page.

For further details on the format property and its usage, please refer to our dedicated documentation.

We hope this guide was helpful. If you have any questions or noticed any issues on the code above,
feel free to drop us a line.