GETTING STARTED

MeloScan uploads

The endpoint the MeloScan iOS app posts to. Anything that can speak the exchange format can use it — measured rooms in, a quote-ready scan in your inbox.

Uploads are key-gated per workspace. Mint or copy the upload key in MeloDocs → Scans; the same screen shows every scan that has arrived. Send the key in the x-meloscan-key header.

POST /api/meloscan/upload

curl -X POST https://melodocs.ai/api/meloscan/upload \
  -H 'Content-Type: application/json' \
  -H 'x-meloscan-key: YOUR_UPLOAD_KEY' \
  -d '{ "rooms": [ /* MeloScan exchange v1 room objects */ ] }'

Each entry in rooms is a MeloScan exchange v1 object — the room's name plus its measured dimensions and geometry, exactly as the app exports them. The payload is stored as sent, so nothing you include is lost.

An empty rooms array is a valid connection test: the key is checked and the response comes back with a count of 0. The app's "Test connection" button does exactly this.

Responses

200 OK

{ "ok": true, "count": 3 }

—401 — the x-meloscan-key header is missing, too short, or not recognized. Regenerate the key in MeloDocs → Scans.

—400 — the body isn't readable JSON.

Updated August 6, 2026Did this page help?

NEXTAuthentication