Get a render
Read a render by ren_… id. Rendering completes on its own; poll until the status is succeeded or failed. A render past its time budget may be marked failed by a read or by the scheduled reaper. A terminal failed render is still a successful read (200) with its closed-list error code.
Publishable key (browser-safe), sent as Authorization: Bearer pk_…. This is the lower API-key tier and is sufficient for browser-safe routes that require the pk tier. Requests using a publishable key are additionally validated against the key's domain allowlist via the Origin header. Used for upload, areas, renders, polling, catalog reads, and history (history additionally requires a visitor token).
In: header
Path Parameters
The ren_… public id returned when the render was created.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/renders/ren_2pL7vQ4mXa9cN6tBhRzK"{ "id": "ren_2pL7vQ4mXa9cN6tBhRzK", "status": "queued", "areaSet": "aset_9mK3pQ7wZxN2vC5tBhLr", "image": "img_7bQ2mR9vXpL4dK1sZeCt", "url": "https://api.viewa.com/api/v1/renders/ren_2pL7vQ4mXa9cN6tBhRzK/file", "error": { "code": "capture_failed", "detail": "string" }, "areas": [ { "area": "area_4nH8xW2qTvB6yJ0aRmDp", "product": "prod_3xK9aQ0ZbW7mNc2LpRvT", "style": "s-wave", "styleOptions": [ { "type": "string", "value": "string" } ], "materials": [ { "optionId": "string", "material": "string" } ], "animation": [ 0 ] } ]}