View all our articles

Save your PDF online and get back a URL in Ruby with Typhoeus

In this guide, we'll show you how you can generate a PDF document from HTML and get back an URL instead of the raw PDF. This allows you to share the link directly to your users or redirect them to that page.

To do so, we are going to pass the filename parameter to the request. It expects a string that will be the name of the file once it is saved on our servers.

require 'typhoeus'
require 'json'

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

params = {
    'source' => '',
    'filename' => 'example.pdf'

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

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

puts 'The PDF document was generated and saved to result.pdf'

In the above example, we used the filename parameter to specify the name of the file once it is saved on our servers. The response will convert the document but return a JSON response instead of the raw PDF.

The body of the response will be similar to this:

    "success": true,
    "url": "",
    "filesize": 34980,
    "duration": 1237,
    "response": {
        "status-code": 200,
        "content-length": 0,
        "requests": 0,
        "duration": 1085.6739225387573
    "executed": "2024-03-06T10:05:51.516413",
    "pdf_pages": 1

NOTE: Using the filename does save your document on our S3 storage for 2 days. After two days, the document is automatically deleted.

NOTE: Since we store your documents on our server, this command is not recommended if you want to be HIPAA compliant.

For further details on the filename 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.