render_artifact

Use this when the user asks to make or create a branded report, invoice, summary, release notes, or document — or to 'turn this Markdown/HTML into a PDF and PNG' (optionally with a logo or accent color). Do NOT use to screenshot an existing URL (use rendex_screenshot). Turns Markdown or HTML into a branded, downloadable artifact — a PDF, a PNG, and a hosted share page — in one call. Apply a logo, accentColor, font, header, and footer. Returns hosted URLs { pdfUrl, pngUrl, shareUrl, expiresAt }. Each requested format costs 1 render credit.

read-only

Argument	Type	Description
data	object	Optional Mustache data. When present, content is rendered as a logic-less Mustache template (plus the branding fields as {{logo}}/{{header}}/...) before conversion.
font	string	CSS font-family stack for the body (e.g. 'Georgia, serif').
logo	string	Absolute http(s) URL of a logo image shown in the header.
footer	string	Plain-text footer line shown at the bottom.
header	string	Plain-text header line shown beside the logo.
content*	string	The Markdown or HTML body to render (up to ~4MB).
formats	array	Which formats to produce. Each costs 1 credit. Default both.
expiresIn	integer	Seconds until the hosted URLs expire (3600-2592000). Default 86400 (24h).
pageSetup	object	Optional paper/viewport setup.
accentColor	string	CSS accent color for the bar, links, and headings (e.g. '#EA580C').
inputFormat	string	How to interpret content. 'markdown' is converted to styled HTML; 'html' is used as a body fragment.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "content"
  ],
  "properties": {
    "data": {
      "type": "object",
      "description": "Optional Mustache data. When present, content is rendered as a logic-less Mustache template (plus the branding fields as {{logo}}/{{header}}/...) before conversion.",
      "additionalProperties": {}
    },
    "font": {
      "type": "string",
      "maxLength": 120,
      "description": "CSS font-family stack for the body (e.g. 'Georgia, serif')."
    },
    "logo": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "Absolute http(s) URL of a logo image shown in the header."
    },
    "footer": {
      "type": "string",
      "maxLength": 2000,
      "description": "Plain-text footer line shown at the bottom."
    },
    "header": {
      "type": "string",
      "maxLength": 2000,
      "description": "Plain-text header line shown beside the logo."
    },
    "content": {
      "type": "string",
      "maxLength": 4000000,
      "minLength": 1,
      "description": "The Markdown or HTML body to render (up to ~4MB)."
    },
    "formats": {
      "type": "array",
      "items": {
        "enum": [
          "pdf",
          "png"
        ],
        "type": "string"
      },
      "default": [
        "pdf",
        "png"
      ],
      "maxItems": 2,
      "minItems": 1,
      "description": "Which formats to produce. Each costs 1 credit. Default both."
    },
    "expiresIn": {
      "type": "integer",
      "maximum": 2592000,
      "minimum": 3600,
      "description": "Seconds until the hosted URLs expire (3600-2592000). Default 86400 (24h)."
    },
    "pageSetup": {
      "type": "object",
      "properties": {
        "size": {
          "enum": [
            "A4",
            "Letter",
            "Legal",
            "Tabloid",
            "A3"
          ],
          "type": "string",
          "description": "PDF paper size. Default A4."
        },
        "scale": {
          "type": "number",
          "maximum": 2,
          "minimum": 0.1,
          "description": "PDF render scale (0.1-2). Default 1."
        },
        "width": {
          "type": "integer",
          "maximum": 3840,
          "minimum": 320,
          "description": "PNG viewport width in px. Default 1280."
        },
        "height": {
          "type": "integer",
          "maximum": 2160,
          "minimum": 240,
          "description": "PNG viewport height in px. Default 800."
        },
        "margin": {
          "type": "object",
          "properties": {
            "top": {
              "type": "string",
              "maxLength": 16
            },
            "left": {
              "type": "string",
              "maxLength": 16
            },
            "right": {
              "type": "string",
              "maxLength": 16
            },
            "bottom": {
              "type": "string",
              "maxLength": 16
            }
          },
          "description": "PDF margins as CSS values (e.g. '1cm').",
          "additionalProperties": false
        },
        "fullPage": {
          "type": "boolean",
          "description": "Capture the full scrollable page for the PNG. Default true."
        },
        "orientation": {
          "enum": [
            "portrait",
            "landscape"
          ],
          "type": "string",
          "description": "PDF orientation. Default portrait."
        }
      },
      "description": "Optional paper/viewport setup.",
      "additionalProperties": false
    },
    "accentColor": {
      "type": "string",
      "maxLength": 64,
      "description": "CSS accent color for the bar, links, and headings (e.g. '#EA580C')."
    },
    "inputFormat": {
      "enum": [
        "markdown",
        "html"
      ],
      "type": "string",
      "default": "markdown",
      "description": "How to interpret content. 'markdown' is converted to styled HTML; 'html' is used as a body fragment."
    }
  },
  "additionalProperties": false
}

rendex_account

Check the Rendex account: which plan it's on, how many render credits have been used vs. the monthly limit (and when it resets), the per-minute rate limit, and a one-tap link to upgrade to a higher tier. Use this whenever the user asks about their usage, remaining quota, current plan, or how to get more renders / stop hitting limits. Read-only — costs no credits.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

rendex_extract

Use this when the user asks to read, extract, get the text/content/article of, or summarize a webpage/URL. Do NOT use for a visual screenshot (use rendex_screenshot). Extracts clean reader-mode content from any webpage as Markdown, JSON, or HTML. Runs the same Chromium render pass as a screenshot, so it captures content after JavaScript runs — handles SPAs that fetch-only readers miss. Strips nav, ads, and boilerplate, returning the article body plus title, byline, and excerpt. Great for feeding page content to an LLM, summarization, or RAG ingestion. Costs 1 render credit per call.

read-only

Argument	Type	Description
url*	string	The webpage URL to extract readable content from (a schemeless host like 'example.com' is accepted).
device	string	Device preset that sets viewport, scale factor, and user agent in one shot. E.g. 'iphone_15' to extract the mobile version of a page.
timeout	integer	Maximum seconds to wait for page load (5-60). Cloudflare has a 60s hard cap.
blockAds	boolean	Block ads and trackers before extraction
waitUntil	string	Page readiness event. networkidle2 (default) is best for most sites. Use domcontentloaded for speed, networkidle0 for completeness.
extractFormat	string	Output shape — markdown (default, LLM-friendly prose), json (structured fields: title/byline/excerpt/siteName/length), or html (cleaned reader-mode HTML).

rendex_render_link

Use this when the user wants a reusable, HOSTED image URL — an og:image or a link to embed in an <img> tag — rather than the image bytes. Do NOT use for a one-off inline screenshot (use rendex_screenshot). Renders a URL, raw HTML, or Markdown and gives back a signed, hosted, edge-cached image URL instead of the bytes — ideal for dynamic OG images: drop the URL into <meta property="og:image"> or an <img> tag and Rendex serves a cached copy on every share. Takes the same options as rendex_screenshot, plus an optional expiresIn. Returns { url, expiresAt, format, cacheTtl } as JSON. Costs 1 render credit per fresh render; cached repeat hits don't re-charge.

read-only

Argument	Type	Description
js	string	Custom JavaScript to execute in the page before capture. Runs in the browser sandbox. Max 50KB.
css	string	Custom CSS to inject into the page before capture. Hide cookie banners, add watermarks, override styles. Max 50KB.
geo	string	ISO 3166-1 alpha-2 country code for geo-targeted capture (e.g., 'US', 'DE', 'JP'). Renders the page as seen from that country. Pro/Enterprise only. Note: CSS/JS injection, cookies, element capture, dark mode, and some other features are not available with geo-targeting.
url	string	The webpage URL to capture (a schemeless host like 'example.com' is accepted). Mutually exclusive with 'html' and 'markdown'.
data	object	Key-value data object for Mustache templating. When provided, the 'html' or 'markdown' string is rendered as a logic-less Mustache template before capture — {{var}} inserts HTML-escaped, {{{var}}} inserts raw, {{#items}}...{{/items}} iterates arrays, {{a.b}} accesses nested fields. Not valid with 'url'. Max 256KB serialized.

rendex_screenshot

Use this when the user asks to screenshot, capture, or take a picture of a webpage/URL, or to render raw HTML or Markdown to an image or PDF. Do NOT use to get a reusable hosted image URL (use rendex_render_link) or to make a branded multi-format document (use render_artifact). Captures a screenshot or PDF of any webpage, raw HTML, or Markdown. Supports full-page capture, dark mode, ad blocking, custom viewports, CSS/JS injection, cookie/header injection, PDF output, HTML and Markdown rendering, and progressive fallback for heavy sites. Returns partial renders on timeout by default (bestAttempt mode). Costs 1 render credit per call. Cookie/header injection requires Starter+; geo-targeting requires Pro+.

read-only

Argument	Type	Description
js	string	Custom JavaScript to execute in the page before capture. Runs in the browser sandbox. Max 50KB.
css	string	Custom CSS to inject into the page before capture. Hide cookie banners, add watermarks, override styles. Max 50KB.
geo	string	ISO 3166-1 alpha-2 country code for geo-targeted capture (e.g., 'US', 'DE', 'JP'). Renders the page as seen from that country. Pro/Enterprise only. Note: CSS/JS injection, cookies, element capture, dark mode, and some other features are not available with geo-targeting.
url	string	The webpage URL to capture (a schemeless host like 'example.com' is accepted). Mutually exclusive with 'html' and 'markdown'.
data	object	Key-value data object for Mustache templating. When provided, the 'html' or 'markdown' string is rendered as a logic-less Mustache template before capture — {{var}} inserts HTML-escaped, {{{var}}} inserts raw, {{#items}}...{{/items}} iterates arrays, {{a.b}} accesses nested fields. Not valid with 'url'. Max 256KB serialized.

watch_create

Use this when the user asks to monitor, watch, or track a webpage for changes, or to be alerted/notified when a page changes. Do NOT use for a one-time capture (use rendex_screenshot). Creates a Rendex Watch — monitors a URL on a schedule and notifies when it changes (real-Chrome visual diff with a highlighted overlay, an extracted-text diff, or both). An active watch captures its baseline immediately. Returns the created watch as JSON.

Argument	Type	Description
url*	string	The page to monitor (a schemeless host like 'rendex.dev/pricing' is upgraded to https).
name	string	Optional label for the watch.
paused	boolean	Create the watch paused (no baseline capture or charge until resumed).
diffMode	string	How changes are detected. Default 'both' = a pixel diff (with a highlighted overlay) AND a FULL-PAGE text diff, alerting on either — catches any change, visual or text. 'visual' or 'text' narrow to one signal only.
aiSummary	boolean	Pro+ — attach a one-sentence AI 'what changed' summary to each detected change.
threshold	number	Visual sensitivity (0..1). Low (default 0.01) alerts on ANY change, including a small one on a long page (a changed-region test, not a whole-page pixel ratio). 0.06+ = only MAJOR visual changes (whole-page ratio). Text detection is unaffected.
webhookUrl

watch_delete

Delete a watch and its run history. Irreversible.

destructive

Argument	Type	Description
id*	string	The watch ID (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The watch ID (UUID)."
    }
  },
  "additionalProperties": false
}

watch_get

Fetch one watch by ID, including its current baseline image URL and status. Returns JSON.

read-only

Argument	Type	Description
id*	string	The watch ID (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The watch ID (UUID)."
    }
  },
  "additionalProperties": false
}

watch_list

List your watches (newest first), optionally filtered by status and paged. Returns { items, nextCursor }.

read-only

Argument	Type	Description
limit	integer	Page size (1–100).
cursor	string	Pagination cursor from a previous nextCursor.
status	string	Filter by status.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1,
      "description": "Page size (1–100)."
    },
    "cursor": {
      "type": "string",
      "description": "Pagination cursor from a previous nextCursor."
    },
    "status": {
      "enum": [
        "active",
        "paused",
        "all"
      ],
      "type": "string",
      "default": "all",
      "description": "Filter by status."
    }
  },
  "additionalProperties": false
}

watch_run

Run an immediate check now (charges 1 credit). Returns the queued run; poll watch_runs for the result or receive a watch.changed webhook.

Argument	Type	Description
id*	string	The watch ID (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The watch ID (UUID)."
    }
  },
  "additionalProperties": false
}

watch_runs

Read a watch's run history (newest first), paged. Each run includes changed, diffScore, and signed before/after/overlay image URLs. Returns { items, nextCursor }.

read-only

Argument	Type	Description
id*	string	The watch ID (UUID).
limit	integer	Page size (1–100).
cursor	string	Pagination cursor from a previous nextCursor.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The watch ID (UUID)."
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1,
      "description": "Page size (1–100)."
    },
    "cursor": {
      "type": "string",
      "description": "Pagination cursor from a previous nextCursor."
    }
  },
  "additionalProperties": false
}

watch_test

Dry-run a watch config BEFORE creating it — render the proposed config once and report what was captured + whether the page is reachable (and the text a text-watch would compare). Creates no watch, no baseline, no diff. Use this to validate a selector/scope/identity first. Returns JSON.

read-only

Argument	Type	Description
url*	string	The page to monitor (a schemeless host like 'rendex.dev/pricing' is upgraded to https).
name	string	Optional label for the watch.
paused	boolean	Create the watch paused (no baseline capture or charge until resumed).
diffMode	string	How changes are detected. Default 'both' = a pixel diff (with a highlighted overlay) AND a FULL-PAGE text diff, alerting on either — catches any change, visual or text. 'visual' or 'text' narrow to one signal only.
aiSummary	boolean	Pro+ — attach a one-sentence AI 'what changed' summary to each detected change.
threshold	number	Visual sensitivity (0..1). Low (default 0.01) alerts on ANY change, including a small one on a long page (a changed-region test, not a whole-page pixel ratio). 0.06+ = only MAJOR visual changes (whole-page ratio). Text detection is unaffected.
webhookUrl

watch_update

Update a watch in place — pause/resume (paused), re-point (url), change schedule/diff/notify settings, or turn a channel off (webhookUrl/notifyEmail = null). Only the fields you send change; renderParams is deep-merged over the existing config. A scope change (url/selector/fullPage/size/device) re-baselines on the next check. Returns the updated watch as JSON.

Argument	Type	Description
id*	string	The watch ID (UUID) to update.
url	string	Re-point to a new URL (clears the baseline; the next check re-baselines).
name	any	Rename the watch (null to clear).
paused	boolean	true to pause the watch, false to resume.
diffMode	string	Change what counts as a change.
aiSummary	boolean	Pro+ — toggle the one-sentence AI 'what changed' summary on each detected change.
threshold	number	Change the visual-change noise floor (0..1).
webhookUrl	any	Starter+ — set or replace the change-webhook target; null to turn it off.
notifyEmail

Rendex: Rendering API for Images, PDFs & Content Extraction

Try it

render_artifact Read-only

Rendex: Rendering API for Images, PDFs & Content Extraction

Try it

render_artifact Read-only

Tools (13)