# PDF to text

Get the text out of a PDF, from all pages or the ones you choose, as plain text in reading order and as a .txt file.

- Endpoint: `POST https://setget.net/v1/tools/pdf-text` with JSON `{"input": {...}}` (add `"wait": 30` to hold the reply until the job finishes)
- MCP: `run_tool` with `slug` = `pdf-text`
- Page: https://setget.net/tools/pdf-text

## Files in, files out

This is a file tool. Its file inputs take file references, not file contents and not web addresses.

- Get a reference by uploading: `curl -T FILE https://setget.net/drop/` prints a line `ref  <id>/f1`. Or `POST https://setget.net/v1/drops` with `{"files":[{"name","size"}]}`, PUT the bytes to the returned `upload.url` with the listed headers, and use the file's `ref`. Over MCP use the `drop` tool. A file under about 700 KB can also be sent in place as a `data:<type>;base64,<content>` URI.
- Uploads are at most 100 MB per file, are readable by anyone with the link, and expire (one hour by default). Programs are refused.
- The tool runs as a job. The reply is `{"tool", "ms", "result", "files", "job"}`: `result` is JSON, and every result file comes back in `files` as `{"name", "size", "content_type", "kind", "url", "ref"}`. Download it from `url`, or pass `ref` as the input of another file tool.
- A job still running when the wait ends answers 202 with `job`. Follow it with `GET https://setget.net/v1/jobs/<id>?wait=30`, or stream progress from `GET https://setget.net/v1/jobs/<id>/events` (over MCP: the `job` tool). A person can watch it at `job.url`.

## Inputs

- `file` (required, file, a file reference such as `DROP_ID/f1`, accepts pdf): The PDF to read.
- `pages` (optional, string): Pages to read. Page numbers and ranges separated by commas, such as 1-3,5,8- (8- means page 8 to the end). odd, even and last also work. Left empty, every page is read.
- `layout` (optional, boolean, default `false`): Keep columns and tables lined up with spaces, as they look on the page. Off, the text follows the reading order, which is better for paragraphs.
- `page_markers` (optional, boolean, default `false`): Put a line such as "--- Page 3 ---" before the text of each page.
- `password` (optional, string): The password of the PDF, if it is locked. It is used once to open the file and is never stored or shown. The result is not locked.

## Example 1: All the text of a PDF

Upload first. Each placeholder below stands for the reference of one upload: `DROP_ID/f1` = [sample.pdf](https://setget.net/static/samples/sample.pdf).

```json
{"input":{"file":"DROP_ID/f1"},"wait":30}
```

## Example 2: One page, with a page marker

Upload first. Each placeholder below stands for the reference of one upload: `DROP_ID/f1` = [sample.pdf](https://setget.net/static/samples/sample.pdf).

```json
{"input":{"file":"DROP_ID/f1","pages":"1","page_markers":true},"wait":30}
```

## Example 3: From page 2 on, keeping the layout

Upload first. Each placeholder below stands for the reference of one upload: `DROP_ID/f1` = [sample.pdf](https://setget.net/static/samples/sample.pdf).

```json
{"input":{"file":"DROP_ID/f1","pages":"2-","layout":true},"wait":30}
```

**Why did I get an error saying there is no text?** The PDF is a scan: each page is a picture, so there are no letters to copy. Run ocr-pdf first. It reads the words out of the pictures.

**When should I turn layout on?** For tables, invoices and forms, where the position of each value matters. Leave it off for articles and books, so that columns are read one after the other.

**How much text comes back?** The result holds up to 200,000 characters and says so when it was cut. The .txt file always holds all of the text.

**Does it keep headings and tables as Markdown?** No, this is plain text. Use pdf-to-markdown for headings, lists and tables.

**Can I use a PDF that is locked with a password?** Yes. Give the password in the password input. It is used once to open the file, is not stored and is not shown anywhere. The result is not locked. Without the right password a locked PDF cannot be read.
