viewa/docs
API Reference

Fetch a succeeded render

GET
/renders/{id}/file

Stream the immutable composite bytes. This URL is unauthenticated so it can be used directly as an <img src>; the opaque ren_… id is the URL credential and the response allows every origin. It returns a uniform bodyless 404 until the render has succeeded or its artifact is unavailable. Optional transforms use Sharp's fit: inside and withoutEnlargement: width is capped at 1024 pixels on the longest edge, format may be jpeg, webp or png, and quality is 1 through 100. Successful render artifacts are immutable and cacheable indefinitely.

Path Parameters

id*string

The ren_… public id returned when the render was created.

Query Parameters

width?integer

Maximum width/longest edge in pixels. Values above 1024 are rejected.

Range1 <= value <= 1024
format?string

Output image format. Defaults to jpeg when any transform is requested.

Value in

  • "jpeg"
  • "webp"
  • "png"
quality?integer

Output quality, from 1 to 100. Applies to transformed output.

Range1 <= value <= 100

Response Body

text/plain

curl -X GET "https://example.com/renders/ren_2pL7vQ4mXa9cN6tBhRzK/file"
"string"