Runs OCR on Floorplans

post

https://client-api.{region}.fieldwire.com/api/v3/projects/{project_id}/floorplans/ocr

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

project_id

uuid

required

ID of the project this entity belongs to

Body Params

Tells Fieldwire to run OCR (Optical Character Recognition) on the list of Floorplan IDs.

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*

name_rotation

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*

description_rotation

integer | null

Degree to rotate the cropped description section of the Floorplan

Headers

Fieldwire-Version

date

required

Specifies the version of the API to talk to

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200Successful response