There is no official Ruby gem, and you do not need one. net/http from the standard library covers the whole API. If you already use Faraday or HTTParty, those work identically.

Install

# nothing to install - net/http ships with Ruby

Your first screenshot in Ruby

One POST, one JSON body, one URL back. The response is a CDN link to the finished image.

net/http

require "net/http"
require "json"

uri = URI("https://api.getsnap.dev/v1/screenshot")

response = Net::HTTP.post(
  uri,
  { url: "https://github.com", format: "png" }.to_json,
  "X-API-Key"    => "sk_live_YOUR_KEY",
  "Content-Type" => "application/json"
)

puts JSON.parse(response.body)["url"]   # CDN URL to your screenshot

Faraday

require "faraday"
require "json"

conn = Faraday.new(url: "https://api.getsnap.dev") do |f|
  f.request :json
  f.response :json
end

result = conn.post("/v1/screenshot") do |req|
  req.headers["X-API-Key"] = "sk_live_YOUR_KEY"
  req.body = { url: "https://github.com", format: "png" }
end

puts result.body["url"]

Full-page captures and other options

Every option is a field in the same JSON body. The common ones are full-page capture, popup and ad removal, viewport size, and lazy-load scrolling.

body = {
  url:             "https://example.com",
  format:          "png",
  full_page:       true,
  remove_popups:   true,
  block_ads:       true,
  lazy_load:       true,
  viewport_width:  1280,
  viewport_height: 720
}.to_json

response = Net::HTTP.post(uri, body,
  "X-API-Key" => "sk_live_YOUR_KEY", "Content-Type" => "application/json")

Saving the image to disk

By default you get a CDN URL. Ask for a binary response instead and you get the bytes directly, which saves a round-trip when you are storing the file yourself.

body = {
  url:           "https://example.com",
  format:        "webp",
  quality:       90,
  response_type: "binary"
}.to_json

response = Net::HTTP.post(uri, body,
  "X-API-Key" => "sk_live_YOUR_KEY", "Content-Type" => "application/json")

File.binwrite("screenshot.webp", response.body)

Handling errors

Every failure returns JSON with an error code and a human-readable message. These are the ones worth branching on:

Status	error	What it means
400	validation_error	A field is missing or out of range. The body names the field.
401	unauthorized	Missing or unknown API key.
402	quota_exceeded	Monthly capture limit reached.
429	rate_limit_exceeded	Too many requests this minute. Back off and retry.
500	capture_failed	The page could not be rendered - usually a timeout on a page that never settles.

response = Net::HTTP.post(uri, body,
  "X-API-Key" => "sk_live_YOUR_KEY", "Content-Type" => "application/json")

case response
when Net::HTTPSuccess
  puts JSON.parse(response.body)["url"]
else
  err = JSON.parse(response.body)
  # e.g. 429 rate_limit_exceeded
  warn "#{response.code} #{err["error"]}: #{err["message"]}"
end

Rate limits and quotas

Plan	Captures / month	Requests / minute
Free	100	5
Starter	5,000	30
Pro	25,000	60
Business	100,000	120

Exceeding the per-minute limit returns 429; exceeding the monthly quota returns 402. See pricing for the full breakdown.

Frequently asked questions

Next steps

• Code examples — every feature, with cURL, Node.js and Python tabs
• API reference — every request field and response shape
• Playground — try a capture in the browser before writing any Ruby
• Pricing — plans, quotas and overage

Related reading

• Best screenshot API in 2026 — how the managed options compare