API Reference
List an image's area sets
The area sets defined on one image, newest first. Unlike reading a single set, this does not advance a set's status - poll GET /areas/{id} for that.
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
image*string
The image whose area sets to list.
page?integer
1-based page number.
Range
1 <= valueDefault
1limit?integer
Items per page.
Range
1 <= value <= 100Default
20Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/areas?image=img_7bQ2mR9vXpL4dK1sZeCt"{ "data": [ { "id": "aset_9mK3pQ7wZxN2vC5tBhLr", "image": "img_7bQ2mR9vXpL4dK1sZeCt", "status": "processing", "areas": [ { "id": "area_4nH8xW2qTvB6yJ0aRmDp", "name": "Living room window", "corners": [ [ 0.21, 0.3 ], [ 0.78, 0.3 ], [ 0.78, 0.82 ], [ 0.21, 0.82 ] ], "measurements": { "width": 1.42, "height": 1.08, "unit": "m" }, "plane": { "rotation": [ 0, 0, 0 ], "center": [ 0, 0, 0 ] } } ], "error": { "code": "occlusion_failed", "detail": "string" } } ], "pagination": { "page": 1, "limit": 1, "totalItems": 0, "totalPages": 0 }}