{"openapi":"3.1.0","info":{"title":"FrontView requests","version":"1.0.0","summary":"Send FrontView a request for a building capture, drone facade & roof capture, or a portfolio conversation.","description":"FrontView scans commercial buildings with professional-grade LiDAR and turns each scan into a true-to-scale 3D record. This endpoint takes the same request as the form at https://frontview.com/get-started/. Send it only on behalf of a real person who asked for it, with their own name and contact details. A person at FrontView reviews every request and replies by email; the scope, the price and the visit are confirmed in writing before anything is scheduled. The full guide: https://frontview.com/llms-full.txt","contact":{"name":"FrontView","url":"https://frontview.com/about/#contact"}},"externalDocs":{"description":"What FrontView does, and how to send a request for a person","url":"https://frontview.com/llms-full.txt"},"servers":[{"url":"https://b3ygazwuycatys2oq7wheysvba0rpywj.lambda-url.us-east-1.on.aws"}],"paths":{"/":{"post":{"operationId":"sendRequest","summary":"Send a request to FrontView","description":"intent: capture (Request a capture), drone (Drone facade & roof capture), portfolio (Talk about a portfolio). A capture needs the building's address, its size and a preferred timing; a drone request needs the address; a portfolio needs neither. Send each request once.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"},"examples":{"capture":{"summary":"A capture, with drone facade & roof","value":{"intent":"capture","building":"123 Main Street, Anytown, ST 12345","size":"20,000 to 50,000 sq ft","floors":"4 to 10","occupancy":"Partly occupied","timing":"In the next few weeks","drone":true,"name":"Dana Reyes","company":"Halden & Co.","role":"Property or asset manager","email":"dana@halden.example","volume":"Just this one","propertyType":"Office","use":"Condition records and lease events","message":"Floor 3 is occupied; the building engineer has the keys. Interested in the AI Building Inspection."}}}}}},"responses":{"201":{"description":"Received. Give the person the reference: no confirmation email is sent, and a person at FrontView replies to them by email.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Received"},"example":{"ok":true,"reference":"FV-2610-ZM4T"}}}},"400":{"description":"The request could not be read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"},"example":{"ok":false,"error":"The request could not be read."}}}},"422":{"description":"Some fields need fixing: each one, with what to fix.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invalid"},"example":{"ok":false,"errors":{"size":"Choose the size"}}}}},"429":{"description":"Too many requests at once. Wait a minute and try once more."},"502":{"description":"The request could not be delivered. Try again once, then call the sales line.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"},"example":{"ok":false,"error":"FrontView could not send your request."}}}}}}}},"components":{"schemas":{"Request":{"title":"A request","type":"object","properties":{"intent":{"type":"string","description":"What the person would like FrontView to do.","oneOf":[{"const":"capture","title":"Request a capture","description":"A FrontView technician scans the building with professional-grade LiDAR, inside and out, and starts its 3D record. Add drone capture of the upper facade and roof with drone: true."},{"const":"drone","title":"Drone facade & roof capture","description":"Drone capture of the upper facade and roof only, added to the building’s record."},{"const":"portfolio","title":"Talk about a portfolio","description":"A conversation about several buildings. No address needed."}]},"building":{"default":"","description":"The building’s street address, city, state and ZIP code, in the United States. Needed for a capture or a drone flight; optional for a portfolio.","type":"string","maxLength":200},"size":{"default":"","description":"The building’s floor area. Needed for a capture: “Not sure” is a fine answer.","type":"string","enum":["Under 5,000 sq ft","5,000 to 20,000 sq ft","20,000 to 50,000 sq ft","50,000 to 100,000 sq ft","Over 100,000 sq ft","Not sure"]},"floors":{"default":"","description":"How many floors the building has. Optional.","type":"string","enum":["1","2 to 3","4 to 10","More than 10","Not sure"]},"occupancy":{"default":"","description":"Whether the spaces are occupied. Optional.","type":"string","enum":["Vacant","Occupied","Partly occupied","Not sure"]},"timing":{"default":"","description":"When the person would like the visit: a preference, not a booking. Needed for a capture.","type":"string","enum":["As soon as possible","In the next few weeks","In the next few months","Flexible"]},"drone":{"default":false,"description":"With a capture: add drone capture of the upper facade and roof. Where drones can’t fly, FrontView captures them from street level, poles, neighboring roofs or on foot.","type":"boolean"},"name":{"type":"string","minLength":2,"maxLength":120,"description":"The person’s full name."},"company":{"type":"string","minLength":2,"maxLength":160,"description":"The person’s company or organization."},"role":{"type":"string","enum":["Broker","Interior designer","Architect or space planner","Owner","Operator","Property or asset manager","Facilities or engineer","Contractor","Appraiser or inspector","Something else"],"description":"The person’s role."},"email":{"type":"string","format":"email","description":"The person’s work email: a person at FrontView replies there. Disposable addresses are refused."},"phone":{"default":"","description":"The person’s phone number, if they would like a call. Optional.","type":"string","maxLength":30},"volume":{"type":"string","enum":["Just this one","2 to 5","6 to 20","More than 20"],"description":"How many buildings the person has in mind."},"propertyType":{"type":"string","enum":["Office","Retail","Industrial","Multifamily","Mixed use","Other"],"description":"The building’s type."},"use":{"type":"string","enum":["Marketing a listing","Design and space planning","Condition records and lease events","Construction and handover","Facilities and equipment","Diligence or financing","Something else"],"description":"What the record is mainly for."},"message":{"default":"","description":"Anything else FrontView should know: access, keys, parking, occupied spaces, or interest in the AI Building Inspection. Optional.","type":"string","maxLength":2000}},"required":["intent","name","company","role","email","volume","propertyType","use"],"additionalProperties":false,"allOf":[{"if":{"properties":{"intent":{"const":"capture"}}},"then":{"required":["building","size","timing"],"properties":{"building":{"minLength":5}}}},{"if":{"properties":{"intent":{"const":"drone"}}},"then":{"required":["building"],"properties":{"building":{"minLength":5}}}}]},"Received":{"type":"object","required":["ok","reference"],"properties":{"ok":{"const":true},"reference":{"type":"string","pattern":"^FV-\\d{4}-[2-9A-HJ-NP-Z]{4}$","description":"The request’s reference: give it to the person."}}},"Invalid":{"type":"object","required":["ok","errors"],"properties":{"ok":{"const":false},"errors":{"type":"object","propertyNames":{"enum":["intent","building","size","floors","occupancy","timing","drone","name","company","role","email","phone","volume","propertyType","use","message"]},"additionalProperties":{"type":"string"}}}},"Problem":{"type":"object","required":["ok","error"],"properties":{"ok":{"const":false},"error":{"type":"string"}}}}}}