---
title: "Runs OCR on Floorplans"
method: POST
path: "/api/v3/projects/{project_id}/floorplans/ocr"
tags: ["floorplans"]
---

# Runs OCR on Floorplans

`POST /api/v3/projects/{project_id}/floorplans/ocr`

## Request

- Base URL: `https://client-api.us.fieldwire.com`
- URL: `https://client-api.us.fieldwire.com/api/v3/projects/{project_id}/floorplans/ocr`
- Auth: HTTP bearer

## Path parameters

- `project_id` string, uuid, required

## Headers

- `Fieldwire-Version` string, date, required

## Request body

- FloorplanOcrInput: Tells Fieldwire to run OCR (Optical Character Recognition) on the list of Floorplan IDs.
  - `floorplan_ids` string[], required: List of Floorplan IDs.
  - `name_box` integer[], required: Bounding box to crop the Floorplans to OCR the name. Formatted as [x1, y1, x2, y2].
  - `name_rotation` integer, nullable: Degree to rotate the cropped name section of the Floorplan
  - `description_box` integer[], required: Bounding box to crop the Floorplans to OCR the description. Formatted as [x1, y1, x2, y2].
  - `description_rotation` integer, nullable: Degree to rotate the cropped description section of the Floorplan

## Response `200`

Successful response

---

[API](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api.md) - [All operations](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api/revisions/34b820438c0b?raw)