Skip to main content
POST
Register Site
Submit a WGS84 GeoJSON Polygon or MultiPolygon in the site property. Mireye prepares the evidence in a bounded worker and returns an opaque site_id with status: "building", or reuses a ready snapshot. Preparation currently has no usage charge. Existing geometry, worker and request limits still apply; this is not an unlimited bulk export service. Oversized or malformed geometry is rejected before work starts, and a full preparation queue returns retryable 429.
Current geometry safeguards are 200,000 acres and 20,000 vertices. These are validation bounds, not a completion-time or throughput guarantee. The handle belongs to the authenticated account. The same account and immutable geometry reuse a handle; another account receives a different handle. Geometry hashes from older integrations are not public access credentials.

Poll preparation

GET /v1/sites/{site_id} returns only status and geometry metadata:
It does not expose the underlying parcel dossier or premium fields. Another account’s handle returns 404 site_not_found. Current source permissions are checked for preparation and reads. Polling remains subject to request limits. Use Ask-site for a cited answer from the prepared data. Dossiers are snapshots with a 30-day retention period. They do not refresh continuously. Re-register an expired or failed site to request a new preparation.

Body

application/json
site
Site · object
required

Response

Successful Response