About this endpoint
What it does
Extracts text from a PDF located at a remote URL and returns the extracted content as a string. You can optionally limit the extraction to a page range and define coordinate bounds for the extracted area.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | Remote PDF URL. Must be a valid URI. |
| end_page | Integer | No | Last page to extract from. Default: 0. Minimum: 0. |
| start_page | Integer | No | First page to extract from. Default: 1. Minimum: 1. |
| ending_x_coordinate | Integer | No | Ending X coordinate for text extraction bounds. Default: 0. Range: 0 to 100. |
| ending_y_coordinate | Integer | No | Ending Y coordinate for text extraction bounds. Default: 0. Range: 0 to 100. |
| preserve_paragraphs | Boolean | No | Preserves paragraph breaks in the extracted text. Default: false. |
| starting_x_coordinate | Integer | No | Starting X coordinate for text extraction bounds. Default: 0. Range: 0 to 100. |
| starting_y_coordinate | Integer | No | Starting Y coordinate for text extraction bounds. Default: 0. Range: 0 to 100. |
Response
Returns a JSON object with a data string field containing the extracted text. Success responses are represented as a JSON object shaped like { data: string }.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | String | Yes | Extracted text content from the PDF. |