---
title: "OCR Result Check"
method: GET
path: "/api/v1/ocr/{request_id}"
---

# OCR Result Check

`GET /api/v1/ocr/{request_id}`

Poll this endpoint to check status of an OCR request and retrieve final results

## Path parameters

- `request_id` string, required

## Cookies

- `wos-session` string
- `datalab_active_team` string

## Response `200`

Successful Response

- OCRFinalResponse
  - `status` string, required — The status of the request. Should be 'complete' when the request is done.
  - `result_url` string, nullable — Signed URL for downloading the completed result JSON when direct result download is required.
  - `expires_in` integer, nullable — Number of seconds until result_url expires.
  - `pages` object[], nullable — The detected OCR text on each page. Each page will have the bboxes and detected text within each line.
  - `success` boolean, nullable — Whether the conversion was successful.
  - `error` string, nullable — If the conversion was not successful, this will contain an error message.
  - `page_count` integer, nullable — The number of pages that had ocr run on them.
  - `total_cost` integer, nullable — The total cost of the conversion.
  - `cost_breakdown` object, nullable — A dictionary of the cost breakdown of this request. Includes the list cost without discounts and final cost to clients after any discounts (e.g. for opting into model training).
  - `versions` union — A dictionary of the versions of the libraries used in the request.
    - object
    - string

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/datalab/apis/datalab-api.md) · [All operations](https://skmtc.net/datalab/apis/datalab-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/datalab/datalab-api/versions/aa9f8ee18efb/schema)
