---
title: "Get OCR requests"
method: GET
path: "/ocrs"
tags: ["OCR"]
---

# Get OCR requests

`GET /ocrs`

## Request

- Base URL: `https://us.app.zuva.ai/api/v2`
- URL: `https://us.app.zuva.ai/api/v2/ocrs`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/zuva/apis/zuva-docai/docs/ocrs/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the status of one or more OCR status requests. Each request ID should be
provided as a query parameter, e.g. `/ocrs?request_id=abcde&request_id=fghijk`

If any or all request IDs are invalid or not found, the overall response will be
`200 Success`, and the response body will contain the individual error messages for
each request ID.

A maximum of 1000 request IDs can be included in a single query.

## Query parameters

- `request_id` string[], required

## Response `200`

The status of multiple OCR requests

- OCRStatuses
  - `errors` object, required
  - `num_errors` integer, required
  - `num_found` integer, required
  - `statuses` object, required

## Other responses

- `400`: Invalid request
- `401`: Unauthorized
- `403`: Forbidden
- `500`: Internal Server Error

## Changes

- **2023-12-13** `51f2a4c5de2e`: 5 info
  - for the `query` request parameter `request_id`, the type was generalized from `string` to `array`
  - added the optional property `statuses/additionalProperties/character_count` to the response with the `200` status
  - added the optional property `statuses/additionalProperties/page_count` to the response with the `200` status
  - added the optional property `statuses/additionalProperties/scan_quality` to the response with the `200` status
  - …1 more
- **2022-12-13** `7cace20deba7`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuva/apis/zuva-docai/changes/ocrs/get.md)

---

[API](https://skmtc.dev/zuva/apis/zuva-docai.md) - [All operations](https://skmtc.dev/zuva/apis/zuva-docai/llms.txt) - [OpenAPI document](https://skmtc.dev/zuva/apis/zuva-docai/revisions/7397ad071d55?raw)