Python SDK — HTML to Image in Python

pip install rendshot

from rendshot import RendshotClient

client = RendshotClient(
    api_key="rs_live_YOUR_KEY",
    base_url="https://api.rendshot.ai",  # optional
)

with RendshotClient(api_key="rs_live_YOUR_KEY") as client:
    result = client.render_image(...)

from rendshot import RendshotClient, RenderImageOptions

client = RendshotClient(api_key="rs_live_YOUR_KEY")

result = client.render_image(RenderImageOptions(
    html='<div style="padding:40px;background:#1a1a2e;color:#fff"><h1>Hello</h1></div>',
    css="h1 { font-size: 48px; }",
    width=1200,
    height=630,
    format="png",
    quality=90,
    device_scale=2,
    fonts=["Inter"],
    timeout=10000,
))

print(result.image_id)  # image id (snake_case; equivalent to `id` in the JS SDK)
print(result.url)       # https://assets.rendshot.ai/...

from rendshot import ScreenshotUrlOptions

result = client.screenshot_url(ScreenshotUrlOptions(
    url="https://example.com",
    width=1280,
    height=800,
    format="png",
    quality=90,
    full_page=False,
    device_scale=2,
    timeout=15000,
))

print(result.url)

from rendshot import RendshotClient, RenderImageOptions

client = RendshotClient(api_key="rs_live_YOUR_KEY")

# 1. Browse available templates
result = client.list_templates(limit=10)
for t in result.templates:
    print(f"{t.id}: {t.name} ({len(t.variables)} vars)")

# 2. Inspect a template's variables
template = client.get_template("tpl_abc123")
for v in template.variables:
    print(f"  {v.key} ({v.type}) = {v.default}")

# 3. Render with variables
image = client.render_image(RenderImageOptions(
    template_id="tpl_abc123",
    variables={"title": "Hello World", "bgColor": "#6B8F5E"},
))
print(image.url)

result = client.ai_render(
    "Social card announcing a product launch, minimal layout",
    platform="twitter_card",   # optional preset
    template_id="tpl_abc123",  # optional: use existing template as style reference
    width=1200,
    height=630,
    format="png",
    locale="en",                # 'zh' | 'en'
)

print(result.url)        # rendered image URL
print(result.html)       # AI-generated template HTML with {{placeholders}}
print(result.variables)  # AI-generated variable definitions

result = client.ai_render("Minimal weekly digest cover", platform="xiaohongshu")

tpl = client.create_template(
    name="Weekly Digest",
    html=result.html,
    variables=result.variables,
    platform="xiaohongshu",
    width=result.width,
    height=result.height,
)

print(tpl.id)  # "tpl_xyz789" — reuse for fast, deterministic renders

from rendshot import TemplateVariable

tpl = client.create_template(
    name="Launch Card",
    html='<div class="card"><h1>{{title}}</h1></div>',
    variables=[
        TemplateVariable(key="title", type="text", label="Title", default="Hello"),
    ],
    platform="twitter_card",
    description="Marketing launch card",
    tags=["marketing", "launch"],
    # visibility="private" by default — publish from the web dashboard
)

print(tpl.id)          # "tpl_abc123"
print(tpl.status)      # "draft"
print(tpl.visibility)  # "private"

from rendshot import AsyncRendshotClient, RenderImageOptions, ScreenshotUrlOptions

async with AsyncRendshotClient(api_key="rs_live_YOUR_KEY") as client:
    # Render HTML to image
    result = await client.render_image(RenderImageOptions(
        html="<h1>Hello World</h1>",
        width=800,
        height=400,
    ))
    print(result.url)

    # Screenshot a URL
    screenshot = await client.screenshot_url(ScreenshotUrlOptions(
        url="https://example.com",
        full_page=True,
    ))
    print(screenshot.url)

    # AI Render
    ai_result = await client.ai_render(
        "Minimal product card for a premium coffee",
        platform="xiaohongshu",
        locale="en",
    )
    print(ai_result.url)

    # Save the AI-generated design as a reusable template
    tpl = await client.create_template(
        name="Coffee Card",
        html=ai_result.html,
        variables=ai_result.variables,
        platform="xiaohongshu",
    )
    print(tpl.id)

usage = client.get_usage()

print(usage.plan)   # "free" | "pro"
print(usage.month)  # "2026-03"
print(usage.count)  # 42
print(usage.limit)  # 100

image = client.get_image("img_abc123")

print(image.image_id)    # "img_abc123"
print(image.url)         # "https://assets.rendshot.ai/..."
print(image.expires_at)  # "2026-04-22T00:00:00Z"

from rendshot import RendshotClient, RendshotError, RenderImageOptions

client = RendshotClient(api_key="rs_live_YOUR_KEY")

try:
    client.render_image(RenderImageOptions(html="<h1>Hello</h1>"))
except RendshotError as e:
    print(e.code)    # e.g. "RATE_LIMIT_EXCEEDED"
    print(e.status)  # e.g. 429
    print(str(e))    # e.g. "Rate limited"