Endpoint for retrieving wireframe images for a specific model. Versions include url, compass, and top.
Retrieving Wireframe Images for a Model
This endpoint should be used to retrieve wireframes for a given model ID. Wireframe images will only return a successful response if the model deliverable type generates the specific wireframe requested.
Reconstructing the Wireframe URL
The wireframe image URLs follow a similar pattern to the above. When a wireframe exists for a model, you can reconstruct the URL using the following format, where the type is the wireframe name (e.g. front, roof, floor_plan) and the version is the display version (e.g. url, compass, top):
https://hover.to/api/v3/models/{model_id}/artifacts/wireframe_{type}.png?version={version}
Example — retrieving the roof wireframe with pitch labels:
https://hover.to/api/v3/models/98765/artifacts/wireframe_roof.png?version=pitches
Available Inputs
Available wireframe type and version inputs. To view and retrieve relevant model ids, use the Job Details endpoint.
| Wireframe Names | Versions Available | Supported Deliverables |
|---|---|---|
wireframe_front.png | url (default), compass, top | Complete (3) |
wireframe_front_right.png | url (default), compass, top | Complete (3) |
wireframe_right.png | url (default), compass, top | Complete (3) |
wireframe_right_back.png | url (default), compass, top | Complete (3) |
wireframe_back.png | url (default), compass, top | Complete (3) |
wireframe_back_left.png | url (default), compass, top | Complete (3) |
wireframe_left.png | url (default), compass, top | Complete (3) |
wireframe_left_front.png | url (default), compass, top | Complete (3) |
wireframe_roof.png | url (default), top, lengths, areas, pitches | Roof Only (2), Complete (3) |
wireframe_total_living_area.png | Total Living Area Plus (5), Total Living Area (6) | |
wireframe_floor_plan.png | Interior (8) | |
wireframe_footprint.png | Complete (3) |
Wireframe Images Example
Below are some example wireframe image outputs depending on version:
Front
Front Compass (this is one example, but all front, left, right, and back views have the accompanying compasses).
Top
Front Right
Wireframe Roof
A roof wireframe is a geometric representation of the roof structure, outlining the basic framework without detailed surface features or textures. This file becomes accessible after a job has been processed in Hover's 3D reconstruction pipeline. Below are some examples of wireframe roofs:
Top
Areas
Pitches
