Starhold Render

Docs

Docs · OG · PDF · Screenshot · Signed URLs · Errors · Limits

The short version

Sign in at /login with your email. You get an API key (shown once).
Send POST with Authorization: Bearer YOUR_API_KEY and a JSON body to https://render.starhold.app/v1/og, /v1/pdf or /v1/screenshot.
The file comes back as the response body. Errors come back as JSON with a code and a link to the error list.

Use a client timeout of 35 seconds: a render may wait up to 10 seconds for a free slot and then run for up to 20.

Reference

POST /v1/og: a template or your own HTML to an image.
GET /v1/og/{template}.png: a signed URL for an og:image tag.
POST /v1/pdf: HTML or a URL to a PDF.
POST /v1/screenshot: a URL or HTML to an image.
Errors and limits.

Response headers

`X-Render-Usage`	renders used / allowance this month, for example `12/50`
`X-Render-Cache`	`hit` or `miss`. Hits are free.
`X-Render-Id`	an opaque id; quote it if you write to us
`X-Render-Warnings`	present when we cut something short, for example `subresource_budget`
`X-Render-Truncated`	`true` when a full-page screenshot was cut at 16,384 CSS px

The Free plan stamps a small watermark on OG images, PDFs and screenshots. Paid plans never do.