Ironfang

Ironfang Render API

Ironfang Render renders web pages to images, PDFs and video. Give it a URL or a block of HTML and get the finished asset without running a browser. No…

Developer tools#development

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Ironfang Render renders web pages to images, PDFs and video. Give it a URL or a
block of HTML and get the finished asset without running a browser.

No attribution on your output

Nothing you render through the API carries an Ironfang badge or watermark,
whatever your billing state. Only the anonymous free tools on
ironfang.com mark their output.

Authentication

Every request carries an API key as a bearer token:

Authorization: Bearer if_live_...

The Bearer prefix is optional: Authorization: if_live_... works the
same, for tools that send the header value exactly as it was pasted. Keys
minted before 27 August 2026 carry an older prefix and keep working.

Keys are created in the portal at https://portal.ironfang.com. They are shown
once at creation and stored only as a hash, so a lost key is replaced rather
than recovered.

Responses are bytes, not JSON

/v1/screenshot, /v1/pdf, /v1/image/{id} and /v1/video return the
rendered file directly. /v1/site-preview returns a multipart payload with
the poster and MP4. Only errors and the metadata endpoints return JSON.

Billing

Ironfang Render has no plans or credits. Usage is billed to your
organisation's Ironfang billing account, which every product shares
(/billing/v1, managed in the portal). Each kind of work counts against a
meter, and each meter has a monthly free allowance (UTC calendar months);
beyond it, usage is pay-as-you-go at graduated rates once paid usage is
enabled on the billing account. The catalogue of meters, allowances and
rates is GET /billing/v1/catalogue.

WorkMeterCounts
Screenshot, signed screenshotrender.screenshot1 per screenshot
PDFrender.pdf1 per PDF of at most 100 pages
Template image, signed imagerender.image1 per image
QR coderender.qr1 per code; a free utility, never charged
Clip, 1080p (vertical, landscape)render.video_second_fhdoutput seconds, rounded up per clip
Clip, 720p or squarerender.video_second_hdoutput seconds, rounded up per clip
Site previewrender.site_preview_secondoutput seconds, rounded up per preview
Capture bundlerender.screenshot1 per bundle, whatever outputs it holds

Every billable request is admitted before any work starts: the most it
can count is reserved, and a request that cannot be admitted is refused
with nothing done. What the work actually produced is committed when it
succeeds - never more than was reserved - and a failure, a refused input
or a cancellation commits nothing. A clip reserves its duration; a site
preview reserves the 60 second limit and commits its real length. Billable
responses say what they counted in X-Ironfang-Meter and
X-Ironfang-Quantity; GET /v1/usage reports the period.

A billing refusal answers with a stable code in the usual error body:
free_allowance_exhausted, account_budget_exhausted or
product_budget_exhausted (429); paid_usage_paused, payment_required,
payment_action_required or account_restricted (402);
product_not_eligible (403); account_closed (410);
operation_too_large (413); billing_temporarily_unavailable (503, with
Retry-After). An API key on an account that belongs to no Ironfang
organisation is 403 account_not_linked.

A PDF may have at most 100 pages. A longer document is refused with
422 pdf_too_long and nothing is counted.

Caching

An identical request made again within ten minutes of the render that
produced it may be served from cache: X-Ironfang-Cache: hit,
X-Ironfang-Quantity: 0, nothing reserved and nothing counted. The cache
is per instance and bounded in size, so an entry can be evicted sooner and
a hit is never guaranteed; after ten minutes the same request is a new,
billable render. PDFs are never cached. Set no_cache: true to force a
fresh render, which is billable; the flag is deliberately excluded from
the cache key, so two fresh requests do not hit each other's results.

Rate limits

Two rate limits apply, both per minute:

  • 120 renders per account, and
  • 60 renders per target host, counted across all customers.

The second protects the sites being rendered: one API call is a full page
load, so a victim's exposure must not scale with our customer count. Both
are checked after the cache and before admission, so a blocked call
reserves and costs nothing.

Capacity limits

Three more limits are the same for every account, and no billing setting
lifts them. They are refused with Ironfang Render's own codes, never a
billing code, and a refused call reserves and costs nothing.

  • 2 browser operations in progress per account. Screenshots, PDFs,

template images and site previews count together, however they
arrived: synchronous requests (signed URLs included) and durable jobs a
worker is running, across the whole service. A synchronous request
over the limit is 429 concurrency_limit with Retry-After; a…

Endpoints 47

Render

  • POSTRender a screenshot/v1/screenshotSupply exactly one of url or html. Returns the image bytes. Counts one render.screenshot.
  • POSTRender a QR code/v1/qrStyled, optionally logo-bearing QR codes, drawn natively and verified before delivery: every response is decoded and compared to data on the way out. A code…
  • POSTRender a PDF/v1/pdfSupply exactly one of url or html. Returns application/pdf. header_html and footer_html are Chromium print templates: they support the classes date, title,…
  • POSTRender a clip/v1/videoA background, captions that appear on a schedule, an optional watermark and an optional audio bed, encoded to MP4. Rendered inside the request, so clips are…
  • POSTRender a scrolling website preview/v1/site-previewLoads and settles a website, preloads lazy content, then records a top-to-bottom browser motion at 30 frames per second. per_page moves one viewport at a time…
  • POSTCapture a bundle from one navigation/v1/bundleLoads a page once and returns the outputs you select from that one navigation: a screenshot, the rendered_html (the DOM after the page's scripts, readiness…

Templates

  • GETList templates/v1/templatesPaged newest first. Follow next_cursor until empty; total is the whole count and does not change between pages. summary=true returns an empty html field;…
  • POSTCreate a template/v1/templatesStore HTML containing {{placeholders}}. Render it with POST /v1/image/{id}, supplying values for the placeholders.
  • GETFetch a template/v1/templates/:idReturns a stored rendering template belonging to the authenticated account, including its HTML and output dimensions.
  • PUTReplace a template/v1/templates/:idReplaces the authenticated account's stored template with the supplied name, HTML and dimensions. Subsequent renders use the updated template.
  • DELETEDelete a template/v1/templates/:idRemoves a stored template from the authenticated account so it can no longer be used for new template renders.
  • POSTRender a template/v1/image/:idSubstitutes vars into the template's {{placeholders}} and renders it at the template's own width and height. Returns the image bytes.

Document templates

  • GETList document templates/v1/document-templatesThe account's document templates, newest first, without their sources. Archived ones only with archived=true.
  • POSTCreate a document template/v1/document-templatesStores a draft. It renders only once published, or as a preview. At most 500 templates per account, archived ones included.
  • GETFetch a document template/v1/document-templates/:idThe template and its draft.
  • PUTReplace a document template's draft/v1/document-templates/:idReplaces the draft. Published revisions and what is published are unchanged until the next publish.
  • DELETEArchive a document template/v1/document-templates/:idArchives the template: it can no longer be edited, published or rendered without a revision number. Its revisions are kept, so jobs accepted before still…
  • POSTValidate a draft against data/v1/document-templates/:id/validateCompiles the draft, checks the data (the body's, else the sample data) against its schema and runs the template, without printing or billing. Always 200;…
  • POSTPreview the draft as a PDF/v1/document-templates/:id/previewPrints the draft with the body's data, else the sample data: what publishing it would produce. A PDF render on the render.pdf meter, like POST /pdf. It…
  • POSTPublish the draft/v1/document-templates/:id/publishMakes the draft the published revision: a new immutable revision, numbered after the last - or, when the draft is exactly the latest revision, that one again.…
  • GETList revisions/v1/document-templates/:id/revisionsThe template's revisions, newest first, without their sources.
  • GETFetch a revision/v1/document-templates/:id/revisions/:nOne revision, with its source.
  • POSTPublish an existing revision/v1/document-templates/:id/revisions/:n/publishPoints unversioned renders at this revision - a rollback, or forward again. Nothing else changes.
  • POSTRender a document/v1/document-templates/:id/renderPrints a revision - the published one unless revision names another - with data. The data is checked and the template run first, before anything is reserved:…

Signed URLs

  • POSTMint a signed render URL/v1/signReturns a URL that renders on GET without an API key - safe to put in an <img> tag or an email. The URL is bound to your account, so renders through it are…
  • GETRender from a signed URL/v1/r/:exp/:sigThe endpoint a signed URL points at. Takes no API key - the signature is the credential - so it can be embedded directly in HTML or email. Call POST /v1/sign…

Batches

  • GETList batches/v1/batchesTenant-scoped metadata, newest first by creation time and ID. Equal timestamps retain stable pagination. Newer insertions do not appear on subsequent pages;…
  • POSTSubmit up to 100 jobs together/v1/batchesOne default request plus items that override parts of it, merged one level deep: an item's field wins, everything else comes from the default. The default is…
  • GETPoll a batch/v1/batches/:idcounts totals the items by state and done is true once none of them can change. jobs is the full job resource for every item.

Destinations

  • GETList destinations/v1/destinationsLive destinations, newest first. Secrets and credentials are never included.
  • POSTRegister a delivery destination/v1/destinationsA destination is created once and named by id from every job, so a signing secret or a set of S3 keys is sent to us on one request and never appears in a job…
  • GETGet a destination/v1/destinations/:idReturns a delivery destination belonging to the authenticated account. Stored delivery credentials are not included in the response.
  • DELETERemove a destination/v1/destinations/:idIt stops receiving anything and leaves the list. Its past deliveries stay, so history still reads true.
  • PATCHRename or enable a destination/v1/destinations/:idname and enabled only. An address or a credential is not edited in place - create a new destination and point your jobs at it, so a delivery's history always…
  • POSTTest a destination now/v1/destinations/:id/testA webhook receives a signed render.destination.test event; a bucket has a uniquely named object written to it. Always 200: the body's ok says whether the…
  • GETList deliveries/v1/deliveriesNewest first, optionally for one destination. A delivery is pending, delivering, delivered or failed; failed means it used up its attempts. Delivery state…
  • GETOne delivery, with the body it posted/v1/deliveries/:idThe list omits payloads because they are the largest part of a delivery and are wanted one at a time, when something has gone wrong. This returns the body…
  • POSTSend a delivery again/v1/deliveries/:id/redeliverPuts a delivery back on the queue with a fresh attempt ladder, for after you have fixed whatever was wrong. The webhook body is rebuilt at send time, so the…

Jobs

  • GETList jobs/v1/jobsNewest first. status filters; active includes queued, running and cancellation_requested. limit up to 100; pass next_cursor back to continue.
  • POSTSubmit a durable render job/v1/jobsThe same renders as the synchronous endpoints - kind is one of screenshot, pdf, qr, image, clip, site_preview, document or bundle and request is that…
  • GETPoll a job/v1/jobs/:idstatus is queued, running, cancellation_requested, succeeded, failed or cancelled. A succeeded job carries result with content_type, bytes, sha256, expires_at…
  • DELETECancel a job/v1/jobs/:idA queued job is cancelled and its reservation released at once; a running one stops at its next safe point, and counts only if it had already produced a…
  • GETCollect a job's result/v1/jobs/:id/resultRedirects (302) to a signed download link valid for 15 minutes; the link needs no API key. With redirect=false the file is returned directly instead, for…
  • GETSigned result download/v1/results/:exp/:sig?job=stringThe link a job's result.url points at. The signature is the authorisation; it expires after 15 minutes.

Account

  • GETWhat Ironfang Render does, is building and does not offer/v1/capabilitiesA dated statement of capabilities with a status of live, planned or not_offered. Public and cacheable; the comparison pages are checked against the same file,…
  • GETRequest history/v1/requestsOne row per authenticated render in the last seven days, newest first, synchronous calls and jobs alike: kind, outcome, safe error code, cache hit or miss,…
  • GETUsage this period/v1/usageThis UTC calendar month's Ironfang Render usage from your organisation's billing account: for every Render meter, what was used, how much of it the free…

API details

Base URL
https://api.ironfang.com/render
https://api.ironfang.com
Authentication
A bearer token in the Authorization header
Operations
47 operations on 35 pathsGET 20POST 20DELETE 4PUT 2PATCH 1
Main resources
Document templates 12Destinations 9Jobs 6Render 6Templates 6Account 3Batches 3Signed URLs 2
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the Ironfang Render API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Ironfang Render API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Render a screenshot” (POST /v1/screenshot), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Ironfang Render API?

Ironfang Render renders web pages to images, PDFs and video. Give it a URL or a block of HTML and get the finished asset without running a browser. No… It is listed under Developer tools and has 47 endpoints.

Who publishes the Ironfang Render API?

It is listed from Ironfang's public API description (an OpenAPI document), not published by Ironfang on Swastik Codes. Anyone who controls ironfang.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Ironfang Render API?

Its description lists 2 base URLs: https://api.ironfang.com/render, https://api.ironfang.com. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Ironfang Render API?

With A bearer token in the Authorization header.

How many endpoints does the Ironfang Render API have?

47 operations on 35 paths (20 GET, 20 POST, 4 DELETE, 2 PUT, 1 PATCH). The largest groups are Document templates, Destinations, Jobs, Render.

Is forking the Ironfang Render API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.