viewa/docs
API Reference

Get an image and advance its preprocessing

GET
/images/{id}

Poll this until status is ready or failed. Reading the resource is what moves it forward: each call checks the preprocessing job once and returns the state that results. Nothing advances in the background, so an image you never poll stays preprocessing. A failed image is still a successful read — the response is 200 and the failure is carried by status and error, not by the HTTP status.

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

Path Parameters

id*string

The img_… public id returned when the image was created.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/images/img_7bQ2mR9vXpL4dK1sZeCt"
{  "id": "img_7bQ2mR9vXpL4dK1sZeCt",  "status": "preprocessing",  "width": 1024,  "height": 768,  "url": "https://api.viewa.com/api/v1/images/img_7bQ2mR9vXpL4dK1sZeCt/file",  "error": {    "code": "preprocessing_failed",    "detail": "string"  }}