API Overview

Endpoints, authentication, rate limits and error handling for the RenderBeam API.

Updated 5/4/2026

Authentication

All API requests require your project's API key in the x-api-key header. Most endpoints additionally need x-project-id.

bash

curl -X POST \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-project-id: YOUR_PROJECT_ID" \
  -H "Content-Type: application/json" \
  https://swnkontrzficuvopeqgd.supabase.co/functions/v1/render-page

API keys are project-scoped and shown once in the dashboard (we store only a SHA-256 hash). Rotate any time from project settings.

Base URL

text

https://swnkontrzficuvopeqgd.supabase.co/functions/v1/{function-name}

Endpoints

POST /render-page

Render a URL and return pre-rendered HTML. Checks cache first.

Body: { "url": "https://yourdomain.com/page", "project_id": "uuid" } Response headers: X-Cache-Status: HIT|MISS, X-Render-Time, X-Rendered-By: RenderBeam.

POST /verify-key

Validate an API key and check remaining quota.

Response:

json

{
  "valid": true,
  "project_id": "uuid",
  "domain": "example.com",
  "remaining": 850,
  "limit": 1000,
  "plan": "starter",
  "cache_ttl_hours": 72
}

GET /bot-regex?project=PROJECT_ID

Returns the combined regex pattern of enabled bots for a project. Used by the worker for bot detection.

POST /clear-cache

Purge cached renders for a project. Auth: Authorization: Bearer JWT_TOKEN.

POST /log-render

Internal: log a render event. Used by the Cloudflare Worker and renderer.

Rate limits

There are no per-minute limits. Your monthly render quota is the only limit:

Plan	Monthly renders	Overage
Starter (free trial)	1,000	Hard cap
5K	5,000	$1.25 / 1,000 (capped at 100% of plan)
15K	15,000	same
50K	50,000	same
125K	125,000	same
250K	250,000	same
500K	500,000	same
1M	1,000,000	same

When over quota and overage is disabled, the API returns 429. Cache hits are free and do not increment the counter — see Cache & billing.

Error handling

Code	Meaning
200	Success
400	Bad request — invalid parameters
401	Unauthorized — invalid or missing API key
403	Forbidden — domain mismatch or unverified project
404	Not found
429	Monthly render limit exceeded
5xx	Server error — fail-open kicks in at the worker

Errors return JSON: { "error": "Domain mismatch — URL does not belong to this project" }.

Was this page helpful?