Ruby

Generate images from a template with net/http from the standard library, with no gem to install. Imejis returns the finished image directly in the response, so there is nothing to poll and no webhook to receive.

Set two environment variables first: IMEJIS_API_KEY (from your dashboard) and IMEJIS_DESIGN_ID (any design's id). Then send the fields you want to change as component.property pairs: headline.text, title.color, image.image. Only the fields you send change; everything else keeps its designed value, and a design's overridable fields are listed in its Share / API panel.

Every block below is a copy-paste runnable program, and every one of them is executed in Docker against a real render service before it ships.

Generate a single imageGenerate a single image

One POST, one image. The response body is the rendered image itself, with nothing to poll and no webhook to receive.

Ruby: Generate a single image

require "json"
require "net/http"
require "uri"
 
API_KEY = ENV.fetch("IMEJIS_API_KEY")
DESIGN_ID = ENV.fetch("IMEJIS_DESIGN_ID")
BASE = ENV.fetch("IMEJIS_RENDER_URL", "https://render.imejis.io")
 
def render(path, params: {}, body: nil)
  uri = URI("#{BASE}#{path}")
  uri.query = URI.encode_www_form(params) unless params.empty?
  request = Net::HTTP::Post.new(uri)
  request["dma-api-key"] = API_KEY
  request["Content-Type"] = "application/json"
  request.body = JSON.dump(body || {})
  Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
    http.request(request)
  end
end
# The size to render on a multi-size design; absent/"master" is the base.
VARIATION = ENV.fetch("IMEJIS_VARIATION_ID", "story")
 
# Render one image. The response body IS the image — no polling, no webhook.
response = render("/v1/#{DESIGN_ID}", body: {
  "headline.text" => "Hello from Ruby",
  "subtitle.text" => "Rendered in one request"
})
File.binwrite("output.jpg", response.body)
puts "single: #{response.code} #{response.body.bytesize} bytes"

Every output format png jpeg webp and pdfEvery output format: PNG, JPEG, WebP and PDF

Pick the output with ?format=. PNG and WebP keep transparency, JPEG is the smallest lossy option, and PDF is a single print-ready page. ?quality= applies to JPEG only.

Ruby: Every output format: PNG, JPEG, WebP and PDF

require "json"
require "net/http"
require "uri"
 
API_KEY = ENV.fetch("IMEJIS_API_KEY")
DESIGN_ID = ENV.fetch("IMEJIS_DESIGN_ID")
BASE = ENV.fetch("IMEJIS_RENDER_URL", "https://render.imejis.io")
 
def render(path, params: {}, body: nil)
  uri = URI("#{BASE}#{path}")
  uri.query = URI.encode_www_form(params) unless params.empty?
  request = Net::HTTP::Post.new(uri)
  request["dma-api-key"] = API_KEY
  request["Content-Type"] = "application/json"
  request.body = JSON.dump(body || {})
  Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
    http.request(request)
  end
end
# The size to render on a multi-size design; absent/"master" is the base.
VARIATION = ENV.fetch("IMEJIS_VARIATION_ID", "story")
 
# Every output format, with JPEG quality. PNG and WebP keep transparency; PDF is
# a single print-ready page. `quality` only affects JPEG.
{ "png" => "png", "jpeg" => "jpg", "webp" => "webp", "pdf" => "pdf" }.each do |fmt, ext|
  params = { "format" => fmt }
  params["quality"] = 85 if fmt == "jpeg"
  res = render("/v1/#{DESIGN_ID}", params: params, body: { "headline.text" => "Format: #{fmt}" })
  File.binwrite("output.#{ext}", res.body)
  puts "formats: #{fmt} #{res['content-type']} #{res.body.bytesize}"
end

Render multiple sizes from one templateRender multiple sizes from one template

A multi-size design carries several canvases: an OG image, a square post, a vertical story. ?variation=<id> picks which one you get back; omit it for the base size.

Ruby: Render multiple sizes from one template

require "json"
require "net/http"
require "uri"
 
API_KEY = ENV.fetch("IMEJIS_API_KEY")
DESIGN_ID = ENV.fetch("IMEJIS_DESIGN_ID")
BASE = ENV.fetch("IMEJIS_RENDER_URL", "https://render.imejis.io")
 
def render(path, params: {}, body: nil)
  uri = URI("#{BASE}#{path}")
  uri.query = URI.encode_www_form(params) unless params.empty?
  request = Net::HTTP::Post.new(uri)
  request["dma-api-key"] = API_KEY
  request["Content-Type"] = "application/json"
  request.body = JSON.dump(body || {})
  Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
    http.request(request)
  end
end
# The size to render on a multi-size design; absent/"master" is the base.
VARIATION = ENV.fetch("IMEJIS_VARIATION_ID", "story")
 
# One template, many sizes. `?variation=<id>` picks the size; omit it for the
# base. The ids are listed in the design's Share / API panel.
res = render("/v1/#{DESIGN_ID}", params: { "format" => "png", "variation" => VARIATION },
                                 body: { "headline.text" => "Story size" })
puts "variation: #{res.code} #{res.body.bytesize} bytes"

An image url for img tags email and thumbnailsAn image URL for `<img>` tags, email and thumbnails

The same render as a plain GET URL, with the field values in the query string. Drop it into an <img src>, an HTML email, or a Slack message and it renders fresh every time it is fetched.

Ruby: An image URL for img tags, email and thumbnails

require "json"
require "net/http"
require "uri"
 
API_KEY = ENV.fetch("IMEJIS_API_KEY")
DESIGN_ID = ENV.fetch("IMEJIS_DESIGN_ID")
BASE = ENV.fetch("IMEJIS_RENDER_URL", "https://render.imejis.io")
 
def render(path, params: {}, body: nil)
  uri = URI("#{BASE}#{path}")
  uri.query = URI.encode_www_form(params) unless params.empty?
  request = Net::HTTP::Post.new(uri)
  request["dma-api-key"] = API_KEY
  request["Content-Type"] = "application/json"
  request.body = JSON.dump(body || {})
  Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
    http.request(request)
  end
end
# The size to render on a multi-size design; absent/"master" is the base.
VARIATION = ENV.fetch("IMEJIS_VARIATION_ID", "story")
 
# The same render as a plain GET URL — drop it into an <img> tag, an HTML email,
# or a Slack message. Field overrides ride the query string.
uri = URI("#{BASE}/v1/#{DESIGN_ID}")
uri.query = URI.encode_www_form(
  "dma-api-key" => API_KEY,
  "format" => "png",
  "headline.text" => "Hello from a URL",
  "subtitle.text" => "No request body needed"
)
puts "get: #{uri}"
res = Net::HTTP.get_response(uri)
puts "get: #{res.code} #{res.body.bytesize} bytes"

Hosted delivery get a public image url backHosted delivery: get a public image URL back

?delivery=hosted stores the render and returns a public URL instead of raw bytes, which is what an email, a webhook payload, or a dashboard needs: a link rather than a file.

Ruby: Hosted delivery: get a public image URL back

require "json"
require "net/http"
require "uri"
 
API_KEY = ENV.fetch("IMEJIS_API_KEY")
DESIGN_ID = ENV.fetch("IMEJIS_DESIGN_ID")
BASE = ENV.fetch("IMEJIS_RENDER_URL", "https://render.imejis.io")
 
def render(path, params: {}, body: nil)
  uri = URI("#{BASE}#{path}")
  uri.query = URI.encode_www_form(params) unless params.empty?
  request = Net::HTTP::Post.new(uri)
  request["dma-api-key"] = API_KEY
  request["Content-Type"] = "application/json"
  request.body = JSON.dump(body || {})
  Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
    http.request(request)
  end
end
# The size to render on a multi-size design; absent/"master" is the base.
VARIATION = ENV.fetch("IMEJIS_VARIATION_ID", "story")
 
# delivery=hosted stores the render and returns a PUBLIC URL instead of bytes —
# for an email, a webhook payload, or a dashboard that needs a link.
res = render("/v1/#{DESIGN_ID}", params: { "delivery" => "hosted", "format" => "png" },
                                 body: { "headline.text" => "Hosted delivery" })
hosted = JSON.parse(res.body)
puts "hosted: #{hosted['url']} #{hosted['file']['size']} bytes"

Signed delivery a private expiring image urlSigned delivery: a private, expiring image URL

?delivery=signed stores the render privately and returns a time-limited signed URL. ?expiresIn= is minutes.

Ruby: Signed delivery: a private, expiring image URL

require "json"
require "net/http"
require "uri"
 
API_KEY = ENV.fetch("IMEJIS_API_KEY")
DESIGN_ID = ENV.fetch("IMEJIS_DESIGN_ID")
BASE = ENV.fetch("IMEJIS_RENDER_URL", "https://render.imejis.io")
 
def render(path, params: {}, body: nil)
  uri = URI("#{BASE}#{path}")
  uri.query = URI.encode_www_form(params) unless params.empty?
  request = Net::HTTP::Post.new(uri)
  request["dma-api-key"] = API_KEY
  request["Content-Type"] = "application/json"
  request.body = JSON.dump(body || {})
  Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
    http.request(request)
  end
end
# The size to render on a multi-size design; absent/"master" is the base.
VARIATION = ENV.fetch("IMEJIS_VARIATION_ID", "story")
 
# delivery=signed stores it privately and returns a time-limited signed URL.
# `expiresIn` is minutes (default 60, max 7 days).
res = render("/v1/#{DESIGN_ID}",
             params: { "delivery" => "signed", "format" => "png", "expiresIn" => 30 },
             body: { "headline.text" => "Signed delivery" })
signed = JSON.parse(res.body)
puts "signed: #{signed['expiresAt']} #{signed['url'][0, 80]}..."

Bulk image generation in one callBulk image generation in one call

POST /bulk to render many images in a single request: several sizes, several data variants, a mix of designs, or the ordered slides of a carousel. results preserves input order, so results[i] is items[i].

Ruby: Bulk image generation in one call

require "json"
require "net/http"
require "uri"
 
API_KEY = ENV.fetch("IMEJIS_API_KEY")
DESIGN_ID = ENV.fetch("IMEJIS_DESIGN_ID")
BASE = ENV.fetch("IMEJIS_RENDER_URL", "https://render.imejis.io")
 
def render(path, params: {}, body: nil)
  uri = URI("#{BASE}#{path}")
  uri.query = URI.encode_www_form(params) unless params.empty?
  request = Net::HTTP::Post.new(uri)
  request["dma-api-key"] = API_KEY
  request["Content-Type"] = "application/json"
  request.body = JSON.dump(body || {})
  Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
    http.request(request)
  end
end
# The size to render on a multi-size design; absent/"master" is the base.
VARIATION = ENV.fetch("IMEJIS_VARIATION_ID", "story")
 
# Many images in ONE call. `results` keeps input order, so results[i] is
# items[i] — for a carousel the array IS the slide order. Each item is one
# metered render, and a failed item does not abort the rest.
res = render("/bulk", body: {
  "delivery" => "hosted",
  "format" => "png",
  "items" => [
    { "designId" => DESIGN_ID, "overrides" => { "headline.text" => "Slide 1" } },
    { "designId" => DESIGN_ID, "variation" => VARIATION, "format" => "jpeg",
      "quality" => 80, "overrides" => { "headline.text" => "Slide 2" } },
    { "designId" => DESIGN_ID, "format" => "pdf",
      "overrides" => { "headline.text" => "Slide 3" } }
  ]
})
bulk = JSON.parse(res.body)
puts "bulk: #{bulk['summary'].to_json}"
bulk["results"].each { |i| puts "   #{i['index']} #{i['format']} #{i['url'] || i['error']}" }

Bulk from a list of rowsBulk from a list of rows

Send data instead of items and every row becomes one render, with no item list to build. That is the shape to reach for when the input is a spreadsheet, a database query, or a CSV.

Ruby: Bulk from a list of rows

require "json"
require "net/http"
require "uri"
 
API_KEY = ENV.fetch("IMEJIS_API_KEY")
DESIGN_ID = ENV.fetch("IMEJIS_DESIGN_ID")
BASE = ENV.fetch("IMEJIS_RENDER_URL", "https://render.imejis.io")
 
def render(path, params: {}, body: nil)
  uri = URI("#{BASE}#{path}")
  uri.query = URI.encode_www_form(params) unless params.empty?
  request = Net::HTTP::Post.new(uri)
  request["dma-api-key"] = API_KEY
  request["Content-Type"] = "application/json"
  request.body = JSON.dump(body || {})
  Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
    http.request(request)
  end
end
# The size to render on a multi-size design; absent/"master" is the base.
VARIATION = ENV.fetch("IMEJIS_VARIATION_ID", "story")
 
# The same design over a LIST OF ROWS — one render per row, no items[] to build.
# Use `variations: ["master", "story"]` instead to render every SIZE.
res = render("/bulk", body: {
  "designId" => DESIGN_ID,
  "delivery" => "signed",
  "expiresIn" => 15,
  "format" => "png",
  "data" => [
    { "headline.text" => "Ada Lovelace", "subtitle.text" => "Mathematician" },
    { "headline.text" => "Alan Turing", "subtitle.text" => "Computer scientist" },
    { "headline.text" => "Grace Hopper", "subtitle.text" => "Rear admiral" }
  ]
})
puts "bulk-data: #{JSON.parse(res.body)['summary'].to_json}"

The response is the raw image (`image/jpeg` by default). Choose the format with `?format=png|jpeg|webp|pdf` (default jpeg) and set JPEG quality with `?quality=1-100`. Store the result and get a URL back with `?delivery=hosted` (or `?delivery=signed&expiresIn=60`), and render a specific size of a multi-size design with `?variation=<id>`.

Parameter	Values	Default	What it does
`?format=`	png · jpeg · webp · pdf	jpeg	Output image format.
`?quality=`	1–100	none	Compression quality for lossy output; ignored for other formats. (JPEG only)
`?delivery=`	stream · hosted · signed	stream	stream = raw image bytes (default); hosted = store + return a public URL; signed = store + return a time-limited URL.
`?expiresIn=`	minutes	60	Signed-URL lifetime in minutes (default 60, max 10080 = 7 days). (delivery=signed only)
`?variation=`	<size id>	master	Which multi-dimension SIZE to render. Omit or use "master" for the base size; an unknown id falls back to the master. (multi-size designs only)

PNG (?format=png): Lossless, supports transparency. Largest file.
JPEG (?format=jpeg): Smaller, lossy, no transparency. Quality adjustable.
WebP (?format=webp): Smallest, supports transparency. Modern browsers.
PDF (?format=pdf): Vector page, for print and documents.

See the delivery modes and generate images with the API guides.

In Rails the same call becomes a controller action; the Rails page has all five, including the params[:format] trap. Net::HTTP.post is a one-shot connection, so batch work is better served by /bulk than by a loop. Each call is one render, with 100 free a month on pricing.