File Exports

Export endpoints generate and return files derived from a plan. All exports are synchronous — the response body is the file.

Subscription requirements

Export type	Required subscription
Floor plan PDF / SVG / HTML	Essential or Integral
Execution plan PDF / SVG / HTML	Essential or Integral
DXF (CAD)	Essential or Integral
Quote document (PDF / CSV / XLSX / HTML)	Integral
Envelope CSV	Integral
gbXML (building energy model)	Integral

A 403 response with "subscription required for this export" means the plan's workspace does not have the required level.

Query parameters

All export endpoints accept these optional query parameters:

Parameter	Type	Default	Description
variant	string	—	Plan variant identifier (e.g. A, B)
floor	number	0	Zero-based floor index to export (0 = ground floor)

---

Floor plan

GET /public/v1/plan/{plan_id}/{format}

format: pdf · svg · html

Exports a 2D top-down view of the floor plan including walls, rooms, items, dimensions, and labels.

Contents: room labels, wall outlines, placed items (furniture, appliances, etc.), measurement annotations, and a legend when applicable.

# Download floor plan as PDF (ground floor)
curl "https://api.visuary.com/public/v1/plan/aBcDeFgH/pdf" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o floorplan.pdf

# Floor 1 of a specific variant
curl "https://api.visuary.com/public/v1/plan/aBcDeFgH/svg?variant=A&floor=1" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o floorplan_f1.svg

📷 [Screenshot: floor plan PDF export]

---

Execution plan (wall dimensions)

GET /public/v1/plan/{plan_id}/exec/{format}

format: pdf · svg · html

Exports a technical dimensioned drawing intended for contractors, showing detailed wall lengths, opening widths, and construction measurements.

Contents: wall dimensions, opening sizes (doors, windows), room surface areas, and a scale indicator. Furniture and decorative items are omitted.

curl "https://api.visuary.com/public/v1/plan/aBcDeFgH/exec/pdf" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o execution_plan.pdf

📷 [Screenshot: execution plan PDF export]

---

DXF export (CAD)

GET /public/v1/plan/{plan_id}/dxf

Exports the floor plan as a DXF file for use in CAD software (AutoCAD, BricsCAD, LibreCAD, etc.).

Contents: walls, openings, rooms, and items as polylines and blocks on separate layers. Coordinates are in millimetres.

curl "https://api.visuary.com/public/v1/plan/aBcDeFgH/dxf" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o floorplan.dxf

The response Content-Type is application/dxf and the filename is set via Content-Disposition.

---

Quote document

GET /public/v1/plan/{plan_id}/quote/{format}

format: pdf · csv · xlsx · html . commonFormat

Exports the bill of materials (BOM) for the plan — a structured list of all items with their quantities, references, and prices.

Contents: item name, category, reference, quantity, unit price, and total. Grouped by room or category depending on workspace settings.

commonFormat is specific in the sense that it is a format which intend to be directly imported into third party softwares. As such, it doesn't include any total (which are computed by the third party software), but includes other data like line type, line number, and tax rate.
Right now works with OBAT, Costructor, Progbat and partly Batappli.

# PDF quote
curl "https://api.visuary.com/public/v1/plan/aBcDeFgH/quote/pdf" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o quote.pdf

# CSV for spreadsheet import
curl "https://api.visuary.com/public/v1/plan/aBcDeFgH/quote/csv" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o quote.csv

# Excel
curl "https://api.visuary.com/public/v1/plan/aBcDeFgH/quote/xlsx" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o quote.xlsx
  
# Commont format for importing in OBAT, Costructor, Progbat, ...
curl "https://api.visuary.com/public/v1/plan/aBcDeFgH/quote/commonFormat" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o quote.xlsx

📷 [Screenshot: quote PDF export]

---

Envelope CSV

GET /public/v1/plan/{plan_id}/envelope/csv

Exports an envelope report as CSV — a per-surface breakdown of the plan used for material estimation (walls, floors, ceilings by room).

Contents: one row per surface (room × face), including surface type, area in m², room name, and material reference if assigned. Useful for calculating quantities of paint, tiles, wallpaper, or flooring.

curl "https://api.visuary.com/public/v1/plan/aBcDeFgH/envelope/csv" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o envelope.csv

CSV columns:

Column	Description
room	Room name
surface	Surface type (floor, ceiling, wall_N)
area_m2	Surface area in square metres
material	Material reference (if assigned)

---

gbXML export (building energy model)

GET /public/v1/plan/{plan_id}/gbxml

Exports the floor plan as a gbXML file (Green Building XML) for use in building energy simulation tools.

The export covers all floors of the plan in a single file. The floor query parameter is not applicable.

Contents:

• One Space per room with floor area and volume
• InteriorFloor and Ceiling surfaces derived from room polygons
• ExteriorWall surfaces at the interior face of the thermal envelope
• InteriorWall surfaces at each partition wall's centre line
• Opening elements (doors, windows) embedded in their parent wall surface
• Construction and Material elements derived from wall layer data where available

curl "https://api.visuary.com/public/v1/plan/aBcDeFgH/gbxml" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o model.gbxml

The response Content-Type is application/xml and the filename is set via Content-Disposition.