viewa/docs
API Reference

List renders for an area set

GET
/renders

Return a paginated, newest-first list filtered by one area set. Listing never advances a render's status. Historical renders remain readable from their snapshot even if the area set is later edited or deleted.

Authorization

AuthorizationBearer <token>

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

Query Parameters

areaSet*string

The aset_… area set whose renders should be listed.

page?integer

1-based page number.

Range1 <= value
Default1
limit?integer

Items per page.

Range1 <= value <= 100
Default20

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/renders?areaSet=aset_9mK3pQ7wZxN2vC5tBhLr"
{  "data": [    {      "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          ]        }      ]    }  ],  "pagination": {    "page": 1,    "limit": 1,    "totalItems": 0,    "totalPages": 0  }}