Skip to main content
POST
Retrieve OCR text

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Body

application/json

File id and page range to get ocr result for.

fileId
integer<int64>
required

The ID of a file in CDF. The file must have mime_type application/pdf, image/jpeg, image/png or image/tiff.

Example:

1234

startPage
integer
default:1

The first page in the range to get ocr results from.

Required range: x >= 1
Example:

1

limit
integer
default:100

The maximum number of pages to get results for. With a limit of 10 and start page of 1, results for pages 1-10 are returned if they are available.

Required range: 1 <= x <= 100
Example:

10

Response

Success

A list of ocr results by page for a single file.

Last modified on October 7, 2026