API Reference

Export a project

post
https://floorplanner.com/api/v2/projects//export.json

Export a project to 2D / 3D images or Virtual staging. There are lot of options but most of them are not required

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
number
required

ID of the project

Body Params
designs
array of numbers

A design id inside an array

designs
fmt
array of strings

Format of the export

fmt
number

Width of the panorama

number

Height of the panorama

boolean

Include FML file in export (2D only)

boolean

Add exports to zip (2D only)

string

Name of the zip file (without extension)

string
enum

Type of export, baked is virtual staging and mesh is a 3D object in GLB format

disclaimer
object
paper
object
fml_overrides
object
views
array of objects
views
string

Specify a http endpoint or valid email address

number

Overwite project template for export

boolean

Return overlay information in the response, this includes camera poses with world to screen and export rectangles

Responses

403

Access denied

404

Project not found

Updated over 2 years ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago