API Reference

The RendShot REST API. Render HTML to images and capture URL screenshots with a single HTTP call.

Overview

Base URL: https://api.rendshot.ai

All requests are authenticated with a Bearer token in the Authorization header:

curl https://api.rendshot.ai/v1/usage \
  -H "Authorization: Bearer rs_live_YOUR_KEY"

Endpoints

Interactive Documentation

Explore all endpoints, try requests, and see response schemas in the interactive API reference:

Open API Reference

Authentication

Create an API key in the Dashboard. Keys use the format rs_live_... and are hashed (SHA-256) before storage. Keep your key secret -- it cannot be retrieved after creation.

Authorization: Bearer rs_live_YOUR_KEY

Rate Limits & Plans

Maximum image dimensions: 4096 x 4096 for all plans.

Error Codes

All errors return a JSON body with { error: { code, message, status } }.

AI Render Endpoint

POST /v1/ai-render turns a prompt into an image. Optionally pass template_id to use an existing template as a visual style reference. The response includes the rendered image plus the AI-generated html and variables, which you can persist via POST /v1/templates for reuse.

See the full AI Render guide for modes, examples, and the generate → save → reuse loop.

curl -X POST https://api.rendshot.ai/v1/ai-render \
  -H "Authorization: Bearer rs_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Minimal product card for a premium coffee",
    "platform": "xiaohongshu",
    "locale": "en"
  }'

The POST /v1/ai-render call counts as one request against your monthly quota — the same as a regular render. No separate AI surcharge.

Create Template Endpoint

POST /v1/templates creates a new template owned by the authenticated API key holder. Templates are always created as private drafts — publish them through the web dashboard if you want them to appear in the public gallery. This endpoint does not consume render quota.

curl -X POST https://api.rendshot.ai/v1/templates \
  -H "Authorization: Bearer rs_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Launch Card",
    "html": "<div class=\"card\"><h1>{{title}}</h1></div>",
    "variables": [
      { "key": "title", "type": "text", "label": "Title", "default": "Hello" }
    ],
    "platform": "twitter_card"
  }'

Each variable in variables has this shape:

{
  "key": "title",
  "type": "text",          // text | image | color | number | select
  "label": "Title",
  "default": "Hello",
  "required": false,
  "maxLength": 100,        // text only
  "min": 0,                // number only
  "max": 1000,             // number only
  "options": ["A", "B"]    // select only
}

Response:

{
  "id": "tpl_abc123",
  "name": "Launch Card",
  "status": "draft",
  "visibility": "private",
  "platform": "twitter_card",
  "width": 1200,
  "height": 628,
  "createdAt": "2026-04-10T12:00:00Z"
}

Next Steps

• Quickstart -- Get your first image in 5 minutes
• JavaScript SDK -- Typed client for Node.js and browsers
• Python SDK -- Official Python client
• CLI -- Command-line rendering tool
• MCP Server -- Integrate with Claude and AI assistants