Generate Open Graph images in Ruby

What you need

• An API key. Create one in the app under API keys and export it as FORMFEED_API_KEY. A test key (ff_test_…) is right for trying things out. See the quick start.
• Ruby. You need Ruby 3; the program uses net/http and json from the standard library.
• The template. og-image from the Open Graph example: Tailwind classes, compiled at render time, no stylesheet to keep.
• The data. The example’s data.json next to the program: category, title, publication date, reading time and the author with an avatar URL.

The program

The program reads data.json, asks for png, marks the output public, waits for the result when the API answers 202, and saves the image; download_url is its address on the CDN.

require "json"
require "net/http"

data = JSON.parse(File.read("data.json"))
body = {
  template: "og-image",
  data: data,
  output: "png",
  access: "public",
}
auth = { "Authorization" => "Bearer #{ENV.fetch("FORMFEED_API_KEY")}" }

response = Net::HTTP.post(
  URI("https://api-eu.formfeed.dev/v1/renders"),
  JSON.generate(body),
  auth.merge("Content-Type" => "application/json")
)
render = JSON.parse(response.body)

# not done within 60 seconds: the answer is 202 and the render goes on in the background;
# its result answers the same way until the render has finished
while response.code == "202"
  sleep 2
  response = Net::HTTP.get_response(URI("https://api-eu.formfeed.dev/v1/renders/#{render["id"]}/result"), auth)
  render = JSON.parse(response.body)
end

# every error is a problem document (RFC 9457) with a title and a detail
abort "#{render["title"]}: #{render["detail"]}" unless response.is_a?(Net::HTTPSuccess)

File.binwrite("og-image.png", Net::HTTP.get(URI(render["download_url"])))
puts "#{render["id"]} #{render["download_url"]}"

Run it

It prints the render’s id and the download URL, and og-image.png lies next to the program. Open it: 1200 × 630 pixels, the title truncated to fit, the avatar round.

export FORMFEED_API_KEY=ff_test_...
ruby render.rb

What is particular about Ruby

• Hashes become JSON. Symbol keys are fine: JSON.generate writes them as strings, and the API’s snake_case names are idiomatic Ruby anyway.
• abort with the problem. A problem document carries a title and a detail; the program prints both and exits with status 1.
• In Rails. Put the call in a job (Active Job, Sidekiq), not in the request cycle: a synchronous render answers when the PDF is done, which can take up to 60 seconds before the API answers 202 and finishes in the background.

What the two options do

• output: "png". Names the format of the image. jpg and webp work as well; the pixel size, the scale factor and the format of a request without output come from the template’s image settings.
• access: "public". Gives a CDN URL without a signature, which is what a meta tag needs: a scraper has no API key. The address works for as long as the file is kept, which the retention of your plan decides, so serve the saved image from your own site when a page is shared for longer. Use it only for images that may be public.

Render once, not on every request

An identical request with a live key within 24 hours is answered from the deduplication cache at zero units, so a second deploy on the same day costs nothing (test keys cost nothing anyway and are never deduplicated). After that the image is rendered again: store the image or its URL with the post and render when the post changes, never inside the page handler, because a social scraper will not wait for a render. See deduplication.

One template, many sizes

Open Graph wants 1200 × 630, and other networks want other frames. Put the size in the request’s settings.image instead of the template, and the same markup renders every format you need.

When the API says no

• One shape for every error. Errors are problem documents (RFC 9457) with type, title, status, detail, a stable code and the request_id to quote to support; the type URL leads to a page about that error. The list is in the error reference.
• The usual ones. 401 unauthorized for a missing or revoked key, 404 template_not_found for a wrong template name, 422 template_runtime_error when the template fails on the data, 429 rate_limited above the plan’s requests per second, 402 quota_exceeded when the Free plan’s units are used up (a paid plan bills extra units up to its hard cap).
• Retry safely. Send an Idempotency-Key header with the POST, and repeat the request with the same key when you do not know whether the first attempt arrived: for 24 hours the key returns the first answer instead of rendering and billing again. The answer is stored once the first attempt has been answered, so do not retry while it may still run; and problems below 500 are stored too, so a corrected request needs a new key.

The job around this program

This guide is one program. What the job needs around it, from the template to the limits and the price, is on the page Open Graph image API.

More Ruby guides

• Generate a PDF invoice from JSON in Ruby
• Create a ZUGFeRD / Factur-X e-invoice in Ruby
• Convert HTML to PDF in Ruby
• Generate PDFs from a CSV in Ruby
• Merge PDFs and add a password in Ruby
• Async PDF rendering with a verified webhook in Ruby

FAQ

Does the image count as a render?

Yes, one unit per image, like a one-page PDF. Test renders are free. See pricing.

Can I use my own fonts?

Yes: link a web font in the template’s head, which the renderer fetches and caches, or, from the Starter plan on, upload font files in the app under Fonts and name the family in your CSS. See fonts.

Why is my text cut off?

The frame is fixed, so a long headline has to give. The example truncates with truncate: 70; a smaller font size or a two-line clamp in CSS works as well.

Open Graph image in other languages

• Node.js (TypeScript)
• Python
• PHP
• Go
• C# (.NET)
• Java
• curl