About this endpoint
What it does
Reads text from one or more public image or PDF URLs and returns one result per image and per PDF page. PDF pages that have a text layer are read directly unless forceOcr is true; every other page is read with OCR in the languages you choose.
Request Body
| Parameter | Type | Description |
|---|---|---|
| urls | String Array | Required. Direct public links to images (png, jpg, webp, tiff, bmp, gif) or PDF files. Min 1, max 100 items. Must be http or https; private and local addresses are rejected. Duplicate URLs are processed once. |
| forceOcr | Boolean | Run OCR on every PDF page, even pages that already have a text layer. Use it when the text layer is wrong or missing. Default: false. |
| languages | ENUM Array | Languages of the text, used only for pages read by OCR. Allowed values: eng, deu, fra, spa, ita, por, bul, rus. Send several for mixed text (a little slower). Default: ["eng"]. |
| outputMode | ENUM | Level of detail for OCR pages. Allowed values: lines, words. lines returns each text line; words returns each word. Both include confidence and bounding box. Default: lines. |
| maxPagesPerPdf | Integer | Read at most this many pages from each PDF, starting at page 1. Range: 1 to 500. Omit to read all pages. |
Response
Returns a JSON object with billed, count and an items array. Each item is either a page result (one per image or PDF page) or a not-found row for a file that could not be read.
| Parameter | Type | Description |
|---|---|---|
| billed | Integer | Number of pages charged for this call. Blank pages and unreadable files are not charged. |
| count | Integer | Number of items returned. |
| items | Object Array | One object per image or PDF page, in the order of urls. |
| items[].sourceUrl | String | URL the result came from. |
| items[].page | Integer | Page number inside the PDF. 1 for images. |
| items[].method | ENUM | How the page was read. Allowed values: ocr, text-layer. |
| items[].text | String | Full text of the page, with lines separated by \n. |
| items[].meanConfidence | Number | Average OCR confidence from 0 to 100. null for text-layer pages. |
| items[].width | Integer | Width of the page or image in pixels (points for text-layer pages). |
| items[].height | Integer | Height of the page or image in pixels (points for text-layer pages). |
| items[].lines | Object Array | Text lines, returned when outputMode is lines and for all text-layer pages. |
| items[].lines[].text | String | Text of the line. |
| items[].lines[].confidence | Number | Line confidence from 0 to 100. null for text-layer pages. |
| items[].lines[].bbox | Integer Array | Bounding box as [x, y, width, height] in pixels. null for text-layer pages. |
| items[].words | Object Array | Single words with text, confidence and bbox, returned when outputMode is words on OCR pages. |
| items[].found | Boolean | false when nothing could be read from the file (blank image, unreachable link, unsupported file). Only present on not-found rows. |
| items[].status | String | Reason for a not-found row. Only present when found is false. |
| items[].input | Object | Echo of the input that produced a not-found row. |
Notes
At most 100 URLs per call and 500 pages per PDF. Links must point straight to the file; HTML pages are not read. Text-layer PDF pages always return lines without confidence or bounding boxes. OCR does not auto-rotate pages, so send upright scans for best results. Each call has a time limit of about 35 seconds, so split very large batches.



