---
title: "Recognize text in a list of bbox regions on a page"
method: POST
path: "/api/v0/components/{component_id}/schematic/ocr-regions"
tags: ["Components"]
---

# Recognize text in a list of bbox regions on a page

`POST /api/v0/components/{component_id}/schematic/ocr-regions`

## Request

- Base URL: `https://api.outerport.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.outerport.com/api/v0/components/{component_id}/schematic/ocr-regions`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/outerport/apis/outerport-api/docs/api/v0/components/:component_id/schematic/ocr-regions/post.ts> (a function with typed inputs; its response is checked against the schema)

Detect → sort → recognize → join, per bbox crop of the rendered page image. Detection finds sub-text-bboxes inside each region, sorted top-to-bottom / left-to-right; recognition then runs on the flat list across all regions; recognized strings are joined with spaces per region in reading order. Two GPU round-trips. Results are ephemeral and not persisted.

## Path parameters

- `component_id` string, required

## Query parameters

- `vc_id` string, required: Public ID of the target visual component

## Request body

- OcrRegionsRequest
  - `regions` OcrRegion[]
    - `entity_id` string, required
    - `bbox` OcrRect, required
      - `x0` number, required
      - `y0` number, required
      - `x1` number, required
      - `y1` number, required
  - `try_rotations` boolean

## Response `200`

Successful Response

- OcrRegionsResponse
  - `result` OcrResultModel[], required
    - `entity_id` string, required
    - `text` string, required
  - `timings` OcrTimings, required
    - `fetch_ms` integer, required
    - `decode_ms` integer, required
    - `detect_ms` integer, required
    - `recognize_ms` integer, required
    - `total_ms` integer, required
  - `image_width` integer, required
  - `image_height` integer, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-25** `fcd15f6d35b4`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/outerport/apis/outerport-api/changes/api/v0/components/:component_id/schematic/ocr-regions/post.md)

---

[API](https://skmtc.dev/outerport/apis/outerport-api.md) - [All operations](https://skmtc.dev/outerport/apis/outerport-api/llms.txt) - [OpenAPI document](https://skmtc.dev/outerport/apis/outerport-api/revisions/08b5bf6f7f18?raw)