POST /scan/extract_text

Die Scan-Endpunkte bereiten das Bild vor, dieser liest es. Sie senden ein Dokumentenfoto und bekommen den erkannten Text als JSON zurück.

Anfragevertrag

POST https://api.scankit.io/scan/extract_text nimmt multipart/form-data mit einem Bild pro Seite: file für eine einzelne Seite, files mehrfach für mehrere Seiten.

Parameter	Standard	Funktion
file oder files	erforderlich	Ein Bild oder mehrere Bilder für eine mehrseitige Erkennung.
ocr_lang	eng	Sprachhinweis für die Erkennung, zum Beispiel eng, deu oder fra.

Sauberer Text aus einem sauberen Bild

Die Erkennungsqualität hängt von der Eingabe ab. Ein gerader, gleichmäßig beleuchteter Scan aus POST /scan/crop wird zuverlässiger erkannt als ein schräg fotografiertes Bild. Die übliche Reihenfolge ist daher erst crop, dann die Texterkennung.

Antwort

Eine Seite liefert den Text als einzelnen String:

json

{
  "success": true,
  "text": "Invoice 2026-0417 ...",
  "language": "eng"
}

Mehrere Seiten liefern einen String pro Seite, in der Reihenfolge der Anfrage:

json

{
  "success": true,
  "texts": ["first page text", "second page text"],
  "page_count": 2,
  "language": "eng"
}

Beispiel

bash

curl -X POST "https://api.scankit.io/scan/extract_text" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@document.jpg" \
  -F "ocr_lang=eng"

Die Antwort ist JSON mit success, text und language. Eine Seite ohne erkennbare Zeichen ist kein Fehler: Sie liefert einen leeren String.

Fehler

Status	Bedeutung	Was zu tun ist
400	Keine Datei	Senden Sie file für eine Seite oder files für mehrere Seiten.
401	Missing API Key oder Invalid API Key	Header X-API-Key mit einem Schlüssel aus einem aktiven Konto senden.
402	Insufficient credits	Credits im Dashboard aufladen.
429	Rate Limit	Die in Retry-After genannten Sekunden abwarten, dann erneut senden.
500	Text extraction failed	Die Erkennung hat für diese Eingabe keinen Text geliefert. Einmal wiederholen, dann das Bild an den Support schicken.

Auf dieser Seite

Anfragevertrag
Antwort
Beispiel
Fehler

Dokumentation