Skip to content

Floorplan API: upload, reconstruct and export a model

Conceptual model only. Not a survey or construction document.

Plan an API workflow for floorplan upload, reconstruction status, revision review and short-lived delivery of a pinned export.

Use the INK TO BRICK API when a product or internal workflow needs to upload floorplans, monitor reconstruction and download a pinned model revision. API access is included on Business. MCP is a conversational layer for existing projects; it does not replace the upload and export endpoints.

Request application access first

Business includes API access for one supported application. Email hello@inktobrick.com with the use case, expected floorplan volume and the application that will make requests. Onboarding assigns the documented OAuth application identity and organization access. Do not put a personal browser token into a server or invent an API-key flow.

The floorplan pipeline

  1. Use the onboarded OAuth application identity and intended organization. Create the project context required by your integration.
  2. Create a floorplan upload with POST /v1/floorplan-uploads, upload the bytes to the returned destination, and complete the upload. Preserve the content hash, byte size, consent record and source-frame metadata used in the request.
  3. Start the supported reconstruction flow, then poll its job until it reaches a terminal state. Do not treat an accepted job as a finished model.
  4. Read the resulting project and revision, compare the geometry with the source, and resolve scale before using dimensions.
  5. Create a hash-pinned export with POST /v1/projects/{projectId}/revisions/{revisionId}/exports. Poll the export job, then request its short-lived delivery grant.

NoteUploads accept supported PDF, PNG, JPEG, SVG or DXF floorplans up to 25 MiB. Keep idempotency keys stable for retries, verify the returned organization and project identifiers, and check authorization again before handing a download to another system.

Choose the handoff for the destination

Common downstream work and the first format to consider.
DestinationFormatLimit to carry forward
Blender or a web 3D pipelineGLB or packaged glTFMesh and material handoff; no parametric building history.
2D CAD reviewDXF or DWGLayered canonical plan; not the original authored CAD or a construction set.
BIM referenceIFC4Canonical rooms, walls, openings and properties; not a native Revit model.
General CAD surface handoffSTEP AP214Faceted BREP surfaces without parametric history.

Worth checkingA successful response proves that the requested operation completed under the API contract. It does not prove survey accuracy, code compliance, structural safety or buildability. Compare the reconstructed model with the source and verify critical dimensions on site.

For conversational review after a project exists, connect Codex through MCP. For the Blender side of the handoff, use the floorplan-to-Blender guide.