API GuideAPI ReferenceQ&AChangelogFieldwire App
API Reference
Start typing to search…

Runs OCR on Floorplans

post
https://client-api.{region}.fieldwire.com/api/v3/projects//floorplans/ocr
Path Params
uuid
required

ID of the project this entity belongs to

Body Params
floorplan_ids
array of uuids
required

List of Floorplan IDs.

floorplan_ids*
name_box
array of integers
required

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

name_box*
integer | null

Degree to rotate the cropped name section of the Floorplan

description_box
array of integers
required

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

description_box*
integer | null

Degree to rotate the cropped description section of the Floorplan

Headers
date
required

Specifies the version of the API to talk to

Response

Updated 7 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
*/*
Updated 7 months ago