mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
00b651c9f8
Shared Claude Code translation pipeline (scripts/i18n, no API key) plus Astro/VitePress/Scalar i18n wiring. Landing and API reference translated into all 20 languages; docs i18n wiring + English source anchors. The translated docs markdown (apps/docs/<locale>/**, 3,620 files) follows in a companion PR because it exceeds GitHub's per-PR CI file limit.
45 lines
1.2 KiB
Markdown
45 lines
1.2 KiB
Markdown
---
|
|
description: Extract plain text from a PDF.
|
|
---
|
|
|
|
# PDF to Text {#pdf-to-text}
|
|
|
|
Extract all readable plain text from a PDF document into a text file.
|
|
|
|
## API Endpoint {#api-endpoint}
|
|
|
|
`POST /api/v1/tools/pdf/pdf-to-text`
|
|
|
|
Accepts multipart form data with a PDF file.
|
|
|
|
## Parameters {#parameters}
|
|
|
|
This tool has no configurable parameters. Upload a PDF and its text content will be extracted.
|
|
|
|
## Example Request {#example-request}
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/pdf/pdf-to-text \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@report.pdf"
|
|
```
|
|
|
|
## Example Response {#example-response}
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/report.txt",
|
|
"originalSize": 520000,
|
|
"processedSize": 14300,
|
|
"chars": 14300
|
|
}
|
|
```
|
|
|
|
## Notes {#notes}
|
|
|
|
- Accepted input format: `.pdf`.
|
|
- This is a fast (synchronous) tool that returns the result directly.
|
|
- The `chars` field in the response indicates the number of characters extracted.
|
|
- Only digitally embedded text is extracted. For scanned documents or image-based PDFs, use the [PDF OCR](./ocr-pdf) tool instead.
|