Read an area set, or a single area
Accepts either an aset_ id, returning the whole set, or an area_ id, returning just that area.
Reading either form advances the set's preparation, but only the set form reports it: a single area carries no status of its own. Poll the aset_ id until its status is ready (or failed). A failed set is still a successful read - 200 with status: failed and an error, not an HTTP error.
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
An aset_ or area_ id.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/areas/string"{ "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" }}