Skip to content

Softaleo API docs

One HTTP API for four rendering jobs: a screenshot of a page, a PDF of a page or a document you send, an image of an HTML fragment, and a templated social image. You send a request; you get a file back.

Start here

  1. Sign in on the dashboard and create a key. The free plan needs no card.
  2. Send the key as authorization: Bearer sk_…. Never in a query string — a GET’s parameters end up in our access log.
  3. Read the response. Every endpoint answers with the file on 200, and a JSON body naming the problem on anything else. Getting started walks the whole of it.

The sheets

Operations

Every operation the API publishes, read from its OpenAPI document
MethodPathWhat it does
POST/v1/html-to-imageRender an HTML string to a PNG
GET/v1/ogRender a templated Open Graph image
POST/v1/pdfRender a URL or an HTML string to a PDF
GET/v1/pingLiveness ping
POST/v1/screenshotRender a URL to a PNG or JPEG

Plans and prices

Flat rate, hard quota, no overage: when a month’s calls are gone the API answers 429 rather than billing you more. Every figure below is read from the API’s own specification at request time, so it is what the process is actually enforcing.

What each plan costs and what it allows, read from the API’s own specification
PlanCalls / monthConcurrentPer minutePriceHow to get it
Free100160$0Create a free key
Starter2,000160$9 / moAsk for this planNot self-serve yet
Pro10,0002120$29 / moAsk for this planNot self-serve yet
Scale30,0002240$79 / moAsk for this planNot self-serve yet

We have not wired card payments yet. Tell us which plan you want and we will move your key onto it, usually the same day — no card, and we will email you when cards work.

Refunds are in the termsAcceptable use