v1

latestOpenAPI 3.0.32026-07-246304082.0 MB
floorplans

Runs OCR on Floorplans

post/api/v3/projects/{project_id}/floorplans/ocr

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Request body

floorplan_idsstring[] required

List of Floorplan IDs.

name_boxinteger[] required

Bounding box to crop the Floorplans to OCR the name. Formatted as [x1, y1, x2, y2].

name_rotationinteger nullable

Degree to rotate the cropped name section of the Floorplan

description_boxinteger[] required

Bounding box to crop the Floorplans to OCR the description. Formatted as [x1, y1, x2, y2].

description_rotationinteger nullable

Degree to rotate the cropped description section of the Floorplan

Response

Successful response