Rendex
App · 7 actions
Turn web pages, HTML and Markdown into images and PDFs, read a page's main text, make branded documents and link-preview images, and check how many renders are left.
Actions
| Action | What it does |
|---|---|
| Create branded document | Make a PDF and/or PNG with your colour, header and footer from Markdown or HTML, with a page to share it. |
| Create image link for a web page | Make an address that serves a page's screenshot whenever it is opened, for a link preview (og:image) or an email. |
| Get account usage | Get the plan, how many renders are used and left this month, when they reset, and the per-minute rate limit. |
| Read a web page's content | Read a web page's main text, without menus, ads or footers, as Markdown, clean HTML or JSON, with its title, author and summary. |
| Render HTML as image or PDF | Turn HTML you supply into a PNG, JPEG or WebP image or a PDF, such as an invoice, a certificate or a social card. |
| Render Markdown as image or PDF | Turn Markdown text into a styled PNG, JPEG or WebP image or a PDF, such as a report or a README. |
| Take screenshot of a web page | Capture a web page as a PNG, JPEG or WebP image or a PDF, on any device size, and save it as a file. |
Create branded document
Make a PDF and/or PNG with your colour, header and footer from Markdown or HTML, with a page to share it. Uses one render per file made.
Inputs
- Content
contenttextRequired - The document's text, in Markdown or HTML (up to 4 MB).
- Content is written in
input_formattext - Defaults to Markdown.One of:
markdown(Markdown (default)),html. - Make
formatslist - Which files to make. Each one uses a render. Defaults to a PDF.One or more of:
pdf,png(PNG image). - Accent colour
accent_colortext - Your brand colour, as a hex code such as #0055ff.
- Header text
headertext - Text for the top of every page, such as your company name.
- Footer text
footertext - Text for the bottom of every page.
- How long it lasts
expires_intext - How long the links keep working. Defaults to 1 day.One of:
3600(1 hour),86400(1 day (default)),604800(7 days),2592000(30 days).
Outputs
expires_attext- When the links stop
pdf_urltext- Link to the PDF
png_urltext- Link to the PNG
share_urltext- A page to share it
Example output
{
"expires_at": "2026-10-27T09:00:00Z",
"pdf_url": "https://api.rendex.dev/v1/images/example.pdf?sig=abc",
"png_url": "",
"share_url": "https://rendex.dev/a/example"
}Create image link for a web page
Make an address that serves a page's screenshot whenever it is opened, for a link preview (og:image) or an email. It is signed, so it needs no key, and stops working after the time you choose.
Inputs
- Web address
urltextRequired - The page to use, as a full address starting with https://.
- File type
formattext - The picture type the link serves. Defaults to PNG.One of:
png(PNG image (default)),jpeg(JPEG image),webp(WebP image). - Whole page
full_pagetrue/false - Capture the page from top to bottom, not just the first screen.
- Device
devicetext - Look at the page as this device does. Leave empty to use the width and height below (a desktop screen by default).One of:
desktop,iphone_15(iPhone 15),iphone_se(iPhone SE),pixel_8(Pixel 8),ipad,ipad_pro(iPad Pro). - Width (pixels)
widthnumber - Screen width in pixels, 320 to 3840. Defaults to 1280.From 320 to 3840.
- Height (pixels)
heightnumber - Screen height in pixels, 240 to 2160. Defaults to 800.From 240 to 2160.
- Dark mode
dark_modetrue/false - Ask the page for its dark colour scheme.
- Hide cookie banners
block_cookie_bannerstrue/false - Remove cookie consent pop-ups before capturing.
- Wait before capturing (seconds)
delay_secondsnumber - Extra time for animations and late content to appear, 0 to 10.From 0 to 10.
- How long it lasts
expires_intext - How long the links keep working. Defaults to 1 day.One of:
3600(1 hour),86400(1 day (default)),604800(7 days),2592000(30 days).
Outputs
expires_attext- When it stops working
image_urltext- The address of the image
source_urltext- The page it shows
Example output
{
"expires_at": "2026-10-27T09:00:00Z",
"image_url": "https://api.rendex.dev/v1/render?p=abc&uid=u1&exp=1&sig=s",
"source_url": "https://example.com"
}Get account usage
Get the plan, how many renders are used and left this month, when they reset, and the per-minute rate limit. Free to run.
Inputs
None.
Outputs
limitnumber- Renders the plan includes
plantext- The plan, such as free
rate_limit_per_minutenumber- Requests allowed per minute
remainingnumber- Renders left this month
resets_attext- When the month resets
top_up_creditsnumber- Bought credits that do not expire
total_remainingnumber- Plan renders plus bought credits left
unlimitedtrue/false- True on unlimited plans
usednumber- Renders used this month
Example output
{
"limit": 100,
"plan": "free",
"rate_limit_per_minute": 3,
"remaining": 88,
"resets_at": "2026-11-01T00:00:00Z",
"top_up_credits": 0,
"total_remaining": 88,
"unlimited": false,
"used": 12
}Read a web page's content
Read a web page's main text, without menus, ads or footers, as Markdown, clean HTML or JSON, with its title, author and summary. Uses one render.
Inputs
- Web address
urltextRequired - The page to use, as a full address starting with https://.
- Return it as
extract_formattext - How to write the page's content. Defaults to Markdown.One of:
markdown(Markdown (default)),html(Clean HTML),json. - Hide cookie banners
block_cookie_bannerstrue/false - Remove cookie consent pop-ups before capturing.
Outputs
bylinetext- The author, if the page says
contenttext- The page's main content
excerpttext- A short summary
formattext- How the content is written
lengthnumber- Length of the content
load_time_msnumber- How long the page took to load, in milliseconds
site_nametext- The site's name
source_urltext- The page read
titletext- The page's title
Example output
{
"byline": "",
"content": "# Example Domain\n\nThis domain is for use in examples.",
"excerpt": "This domain is for use in examples.",
"format": "markdown",
"length": 52,
"load_time_ms": 980,
"site_name": "example.com",
"source_url": "https://example.com",
"title": "Example Domain"
}Render HTML as image or PDF
Turn HTML you supply into a PNG, JPEG or WebP image or a PDF, such as an invoice, a certificate or a social card. Uses one render.
Inputs
- HTML
htmltextRequired - The page to render, as HTML (up to 5 MB).
- Template values
dataobject - Values to fill into `{{name}}` placeholders in your text, such as `{"name": "Jo"}`. Leave empty if there are none.
- File type
formattext - What to make. Defaults to a PNG image.One of:
png(PNG image (default)),jpeg(JPEG image),webp(WebP image),pdf(PDF document). - Whole page
full_pagetrue/false - Capture the page from top to bottom, not just the first screen.
- Device
devicetext - Look at the page as this device does. Leave empty to use the width and height below (a desktop screen by default).One of:
desktop,iphone_15(iPhone 15),iphone_se(iPhone SE),pixel_8(Pixel 8),ipad,ipad_pro(iPad Pro). - Width (pixels)
widthnumber - Screen width in pixels, 320 to 3840. Defaults to 1280.From 320 to 3840.
- Height (pixels)
heightnumber - Screen height in pixels, 240 to 2160. Defaults to 800.From 240 to 2160.
- Dark mode
dark_modetrue/false - Ask the page for its dark colour scheme.
- Capture only this part
selectortext - A CSS selector, such as `#pricing`. Only that part of the page is captured. Leave empty for the whole page.
- Wait before capturing (seconds)
delay_secondsnumber - Extra time for animations and late content to appear, 0 to 10.From 0 to 10.
- Capture when
wait_untiltext - When the page counts as ready. Pages of your own HTML or Markdown default to 'Page has loaded'; web addresses default to 'Network is nearly quiet', which suits pages that load content as they open.One of:
load(Page has loaded),domcontentloaded(Page structure is ready (fastest)),networkidle2(Network is nearly quiet (default for web addresses)),networkidle0(Network is completely quiet (slowest)). - PDF page size
pdf_page_sizetext - The paper size of the PDF. Defaults to A4.Only when File type is PDF document. One of:
A4(A4 (default)),Letter,Legal,Tabloid,A3. - Landscape
pdf_landscapetrue/false - Lay the PDF's pages out wide instead of tall.Only when File type is PDF document.
Outputs
captured_attext- When it was captured
content_typetext- The file's type, such as image/png or application/pdf.
document_reftext- The saved file, for steps that take a file.
filenametext- The file's name.
formattext- png, jpeg, webp or pdf
heightnumber- Page height in pixels, before any Retina scaling
load_time_msnumber- How long the page took to load, in milliseconds
render_qualitytext- full, degraded or best_attempt. Anything but full means the page did not finish loading before Rendex captured it.
size_bytesnumber- The file's size in bytes.
source_urltext- The page captured, empty for HTML and Markdown
urltext- A link that opens the file in Lodol.
widthnumber- Page width in pixels, before any Retina scaling
Example output
{
"captured_at": "2026-10-26T09:00:00Z",
"content_type": "image/png",
"document_ref": "doc_0123456789abcdef0123456789abcdef",
"filename": "rendex-html.png",
"format": "png",
"height": 800,
"load_time_ms": 1420,
"render_quality": "full",
"size_bytes": 48213,
"source_url": "",
"url": "/actions/core/serve-document/doc_0123456789abcdef0123456789abcdef",
"width": 1280
}Render Markdown as image or PDF
Turn Markdown text into a styled PNG, JPEG or WebP image or a PDF, such as a report or a README. Uses one render.
Inputs
- Markdown
markdowntextRequired - The text to render, written in Markdown (up to 5 MB).
- Template values
dataobject - Values to fill into `{{name}}` placeholders in your text, such as `{"name": "Jo"}`. Leave empty if there are none.
- File type
formattext - What to make. Defaults to a PNG image.One of:
png(PNG image (default)),jpeg(JPEG image),webp(WebP image),pdf(PDF document). - Whole page
full_pagetrue/false - Capture the page from top to bottom, not just the first screen.
- Device
devicetext - Look at the page as this device does. Leave empty to use the width and height below (a desktop screen by default).One of:
desktop,iphone_15(iPhone 15),iphone_se(iPhone SE),pixel_8(Pixel 8),ipad,ipad_pro(iPad Pro). - Width (pixels)
widthnumber - Screen width in pixels, 320 to 3840. Defaults to 1280.From 320 to 3840.
- Height (pixels)
heightnumber - Screen height in pixels, 240 to 2160. Defaults to 800.From 240 to 2160.
- Dark mode
dark_modetrue/false - Ask the page for its dark colour scheme.
- Wait before capturing (seconds)
delay_secondsnumber - Extra time for animations and late content to appear, 0 to 10.From 0 to 10.
- Capture when
wait_untiltext - When the page counts as ready. Pages of your own HTML or Markdown default to 'Page has loaded'; web addresses default to 'Network is nearly quiet', which suits pages that load content as they open.One of:
load(Page has loaded),domcontentloaded(Page structure is ready (fastest)),networkidle2(Network is nearly quiet (default for web addresses)),networkidle0(Network is completely quiet (slowest)). - PDF page size
pdf_page_sizetext - The paper size of the PDF. Defaults to A4.Only when File type is PDF document. One of:
A4(A4 (default)),Letter,Legal,Tabloid,A3. - Landscape
pdf_landscapetrue/false - Lay the PDF's pages out wide instead of tall.Only when File type is PDF document.
Outputs
captured_attext- When it was captured
content_typetext- The file's type, such as image/png or application/pdf.
document_reftext- The saved file, for steps that take a file.
filenametext- The file's name.
formattext- png, jpeg, webp or pdf
heightnumber- Page height in pixels, before any Retina scaling
load_time_msnumber- How long the page took to load, in milliseconds
render_qualitytext- full, degraded or best_attempt. Anything but full means the page did not finish loading before Rendex captured it.
size_bytesnumber- The file's size in bytes.
source_urltext- The page captured, empty for HTML and Markdown
urltext- A link that opens the file in Lodol.
widthnumber- Page width in pixels, before any Retina scaling
Example output
{
"captured_at": "2026-10-26T09:00:00Z",
"content_type": "image/png",
"document_ref": "doc_0123456789abcdef0123456789abcdef",
"filename": "rendex-markdown.png",
"format": "png",
"height": 800,
"load_time_ms": 1420,
"render_quality": "full",
"size_bytes": 48213,
"source_url": "",
"url": "/actions/core/serve-document/doc_0123456789abcdef0123456789abcdef",
"width": 1280
}Take screenshot of a web page
Capture a web page as a PNG, JPEG or WebP image or a PDF, on any device size, and save it as a file. Uses one render.
Inputs
- Web address
urltextRequired - The page to use, as a full address starting with https://.
- File type
formattext - What to make. Defaults to a PNG image.One of:
png(PNG image (default)),jpeg(JPEG image),webp(WebP image),pdf(PDF document). - Whole page
full_pagetrue/false - Capture the page from top to bottom, not just the first screen.
- Device
devicetext - Look at the page as this device does. Leave empty to use the width and height below (a desktop screen by default).One of:
desktop,iphone_15(iPhone 15),iphone_se(iPhone SE),pixel_8(Pixel 8),ipad,ipad_pro(iPad Pro). - Width (pixels)
widthnumber - Screen width in pixels, 320 to 3840. Defaults to 1280.From 320 to 3840.
- Height (pixels)
heightnumber - Screen height in pixels, 240 to 2160. Defaults to 800.From 240 to 2160.
- Dark mode
dark_modetrue/false - Ask the page for its dark colour scheme.
- Hide cookie banners
block_cookie_bannerstrue/false - Remove cookie consent pop-ups before capturing.
- Hide these parts
hide_selectorstext - Parts of the page to hide, as CSS selectors, one per line, such as `.newsletter-popup`.
- Capture only this part
selectortext - A CSS selector, such as `#pricing`. Only that part of the page is captured. Leave empty for the whole page.
- Wait before capturing (seconds)
delay_secondsnumber - Extra time for animations and late content to appear, 0 to 10.From 0 to 10.
- Capture when
wait_untiltext - When the page counts as ready. Pages of your own HTML or Markdown default to 'Page has loaded'; web addresses default to 'Network is nearly quiet', which suits pages that load content as they open.One of:
load(Page has loaded),domcontentloaded(Page structure is ready (fastest)),networkidle2(Network is nearly quiet (default for web addresses)),networkidle0(Network is completely quiet (slowest)). - PDF page size
pdf_page_sizetext - The paper size of the PDF. Defaults to A4.Only when File type is PDF document. One of:
A4(A4 (default)),Letter,Legal,Tabloid,A3. - Landscape
pdf_landscapetrue/false - Lay the PDF's pages out wide instead of tall.Only when File type is PDF document.
Outputs
captured_attext- When it was captured
content_typetext- The file's type, such as image/png or application/pdf.
document_reftext- The saved file, for steps that take a file.
filenametext- The file's name.
formattext- png, jpeg, webp or pdf
heightnumber- Page height in pixels, before any Retina scaling
load_time_msnumber- How long the page took to load, in milliseconds
render_qualitytext- full, degraded or best_attempt. Anything but full means the page did not finish loading before Rendex captured it.
size_bytesnumber- The file's size in bytes.
source_urltext- The page captured, empty for HTML and Markdown
urltext- A link that opens the file in Lodol.
widthnumber- Page width in pixels, before any Retina scaling
Example output
{
"captured_at": "2026-10-26T09:00:00Z",
"content_type": "image/png",
"document_ref": "doc_0123456789abcdef0123456789abcdef",
"filename": "rendex-example-com.png",
"format": "png",
"height": 800,
"load_time_ms": 1420,
"render_quality": "full",
"size_bytes": 48213,
"source_url": "https://example.com",
"url": "/actions/core/serve-document/doc_0123456789abcdef0123456789abcdef",
"width": 1280
}