Renderfy Docs

Quickstart

Get your first render in under 2 minutes.

1. Sign up — 100 free credits, no card needed.
2. Go to Dashboard → API Keys and create a key.
3. Make your first request:

curl -X POST https://renderfy.io/api/v1/render \
  -H "Authorization: Bearer rfy_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "tailwind",
    "content": "<div class=\"flex h-full items-center justify-center bg-zinc-900 text-white text-4xl font-bold\">Hello, Renderfy</div>",
    "options": { "format": "png", "dimensions": "og-image" }
  }' \
  --output hello.png

Authentication

All requests must include your API key in the Authorization header as a Bearer token.

Authorization: Bearer rfy_live_YOUR_API_KEY

Keys begin with rfy_live_. Create and revoke keys from your dashboard. A missing or invalid key returns 401. An insufficient credit balance returns 402.

POST /api/v1/render

Renders the provided content to the specified output format. Returns the binary image or PDF directly in the response body. Synchronous — no polling required.

Request body

All fields are top-level JSON properties.

Input types

{ "type": "tailwind", "content": "<div class=\"flex h-full items-center justify-center bg-zinc-900 text-white text-4xl font-bold\">Hello</div>", "options": { "format": "png", "dimensions": "og-image" } }

{ "type": "html", "content": "<div style=\"background:#000;color:#fff;padding:40px;font-size:32px;font-weight:bold\">Hello</div>", "options": { "format": "png" } }

{ "type": "markdown", "content": "# Release Notes\n\n## v2.0\n\n- New feature A\n- Fixed bug B", "options": { "format": "pdf", "dimensions": "a4" } }

{ "type": "code", "content": "const greet = (name: string) => `Hello, ${name}!`;", "lang": "typescript", "theme": "one-dark-pro", "options": { "format": "png" } }

{ "type": "chart", "content": "{\"type\":\"bar\",\"labels\":[\"Q1\",\"Q2\",\"Q3\"],\"datasets\":[{\"data\":[120,145,98],\"color\":\"#00e676\"}],\"title\":\"Revenue\"}", "options": { "format": "png", "dimensions": "1200x800" } }

{ "type": "diagram", "content": "flowchart TD\n  A[Client] --> B(API)\n  B --> C[Database]", "options": { "format": "png", "dimensions": "1200x800" } }

{ "type": "math", "content": "\\sum_{i=1}^{n} i = \\frac{n(n+1)}{2}", "options": { "format": "png" } }

Dimensions

Named presets and custom sizes.

For a custom size, pass a string in "WxH" format: "600x200", "1600x900", etc.

Response

A successful render returns 200 OK with the binary image or PDF as the response body.

Error codes

All error responses return a JSON body: { "error": "message" }

Examples

Node.js / TypeScript

async function render(content: string, type = 'tailwind') {
  const res = await fetch('https://renderfy.io/api/v1/render', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${process.env.RENDERFY_API_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      type,
      content,
      options: { format: 'png', dimensions: 'og-image' },
    }),
  });

  if (!res.ok) {
    const { error } = await res.json();
    throw new Error(`Render failed: ${error}`);
  }

  return Buffer.from(await res.arrayBuffer());
}

Python

import requests
import os

def render(content: str, type: str = "tailwind") -> bytes:
    response = requests.post(
        "https://renderfy.io/api/v1/render",
        headers={
            "Authorization": f"Bearer {os.environ['RENDERFY_API_KEY']}",
            "Content-Type": "application/json",
        },
        json={
            "type": type,
            "content": content,
            "options": {"format": "png", "dimensions": "og-image"},
        },
    )
    response.raise_for_status()
    return response.content

PHP

function renderfy(string $content, string $type = 'tailwind'): string {
    $ch = curl_init('https://renderfy.io/api/v1/render');
    curl_setopt_array($ch, [
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_POST           => true,
        CURLOPT_HTTPHEADER     => [
            'Authorization: Bearer ' . $_ENV['RENDERFY_API_KEY'],
            'Content-Type: application/json',
        ],
        CURLOPT_POSTFIELDS     => json_encode([
            'type'    => $type,
            'content' => $content,
            'options' => ['format' => 'png', 'dimensions' => 'og-image'],
        ]),
    ]);
    $result = curl_exec($ch);
    curl_close($ch);
    return $result; // binary PNG
}

cURL

curl -X POST https://renderfy.io/api/v1/render \
  -H "Authorization: Bearer rfy_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "tailwind",
    "content": "<div class=\"flex h-full items-center justify-center bg-zinc-900 text-white text-4xl font-bold\">Hello</div>",
    "options": { "format": "png", "dimensions": "og-image" }
  }' \
  --output output.png

TypeScript SDK

Skip the raw HTTP layer — the official SDK gives you typed methods, autocomplete, and built-in error handling.

import { Renderfy } from "@renderfy/sdk";

const renderfy = new Renderfy({ apiKey: process.env.RENDERFY_API_KEY! });

const { data } = await renderfy.tailwind(
  `<div class="flex h-full items-center justify-center bg-zinc-900 text-white text-4xl font-bold">
     Hello, Renderfy
   </div>`,
  { format: "png", dimensions: "1200x630" }
);