RenderScreenshot

Response Headers

RenderScreenshot includes useful HTTP headers with every response.

Standard Headers

Content-Type

The MIME type of the response:

Content-Type: image/png
Content-Type: image/jpeg
Content-Type: image/webp
Content-Type: application/pdf

Content-Length

Size of the response body in bytes:

Content-Length: 245632

Custom Headers

X-Cache-URL

A public CDN URL for the screenshot that requires no authentication:

X-Cache-URL: https://cdn.renderscreenshot.com/screenshots/abc123.png

Use this URL for public embedding without exposing your API key.

X-Request-Id

Unique identifier for the request. Include it when you contact support:

X-Request-Id: 6f1c2b9e-4d3a-4e8b-9c1f-2a7d5e0b8c34

X-Cache-Hit

true when the image came from an earlier render (a cache hit with cache.available), false when it was rendered for this request:

X-Cache-Hit: true
X-Cache-Hit: false

X-Screenshot-Width and X-Screenshot-Height

The size of the screenshot:

X-Screenshot-Width: 1280
X-Screenshot-Height: 800

The values are in CSS pixels. With viewport.scale above 1, the image file has more pixels: multiply by the scale. After output.resize, the values are the size of the resized image.

X-Screenshot-Title, X-Screenshot-Description and X-Screenshot-Favicon

The page title, meta description and absolute favicon URL. A header is left out when the page has no value. Values are at most 256 characters, and a value with non-ASCII characters is sent as percent-encoded UTF-8. See metadata. The content enrichment use case turns them into alt text.

X-Screenshot-Title: Example Domain

X-Credits-Used and X-Credits-Remaining

Credits this request used (0 for a cache hit) and the credits left on your account:

X-Credits-Used: 1
X-Credits-Remaining: 149

Rate Limit Headers

X-RateLimit-Limit

Your rate limit per minute:

X-RateLimit-Limit: 60

X-RateLimit-Remaining

Requests remaining in the current window:

X-RateLimit-Remaining: 45

X-RateLimit-Reset

Unix timestamp when the rate limit resets:

X-RateLimit-Reset: 1705312800

Cache Management Headers

These headers are returned by the cache management endpoints.

X-Cache-Key

The full storage key for the cached screenshot:

X-Cache-Key: screenshots/abc123

X-Cache-Hit

The cache endpoints also return X-Cache-Hit: true.

X-Cache-Expires

ISO 8601 timestamp when this cache entry expires:

X-Cache-Expires: 2024-01-19T00:00:00Z

Based on the TTL configured when the screenshot was captured (default: 24 hours).

See Also

Was this page helpful?