Home report

Production

https://api.cubi.casa

POST

/exporter/floorplan/{model_ID}

Export home report

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🔴500Server Error

🟢200Success

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.cubi.casa/exporter/floorplan/' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "exports": [
        {
            "homereportFloors": {
                "assets": {
                    "logo": {
                        "url": ""
                    }
                },
                "labels": {
                    "disclaimer": {
                        "text": [
                            "Layout and dimensions are approximate. For marketing only. Not for contract use."
                        ]
                    }
                }
            },
            "homereportFrontpage": {
                "assets": {
                    "logo": {
                        "url": ""
                    }
                },
                "labels": {
                    "disclaimer": {
                        "text": [
                            "Layout and dimensions are approximate. For marketing only. Not for contract use."
                        ]
                    }
                }
            },
            "homereportMeasurements": {
                "assets": {
                    "logo": {
                        "url": ""
                    }
                },
                "labels": {
                    "disclaimer": {
                        "text": [
                            "Layout and dimensions are approximate. For marketing only. Not for contract use."
                        ]
                    }
                }
            },
            "mergePdfs": [
                "homereportFrontpage",
                "homereportFloors",
                "homereportMeasurements"
            ],
            "modelOptions": {
                "unit": "ft"
            },
            "zip": false
        }
    ]
}'

Response Example

200 - Example

{
    "0": {
        "zip": [
            "url of the file"
        ]
    }
}

Modified at 2025-09-19 13:24:10