About this endpoint
What it does
Extracts text from an uploaded PDF file and returns the extracted content as a string.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| file | String | Yes | PDF file (.pdf). |
| end_page | Integer | No | Last page to extract. Default: 0 (all pages). Minimum: 0. |
| start_page | Integer | No | First page to extract. Default: 1. Minimum: 1. |
| ending_x_coordinate | Integer | No | Ending X coordinate for extraction area. Default: 0. Range: 0 to 100. |
| ending_y_coordinate | Integer | No | Ending Y coordinate for extraction area. Default: 0. Range: 0 to 100. |
| preserve_paragraphs | ENUM | No | Whether to preserve paragraph structure. Allowed values: true, false. Default: false. |
| starting_x_coordinate | Integer | No | Starting X coordinate for extraction area. Default: 0. Range: 0 to 100. |
| starting_y_coordinate | Integer | No | Starting Y coordinate for extraction area. Default: 0. Range: 0 to 100. |
Response
Returns a JSON object with a data string field containing the extracted PDF text.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | String | Yes | Extracted text from the PDF document. |