API-Übersicht

Die ImageToTable.ai v1 API extrahiert strukturierte Daten aus Fotos, Scans und PDFs von realen Dokumenten – Rechnungen, Quittungen, Kontoauszügen, Bestellungen und ähnlichen – und gibt sie als JSON zurück. Diese Seite stellt die vier Ressourcen vor, auf denen alle anderen Dokumentationen in diesen Docs aufbauen.

Kernkonzepte

Vier Ressourcen decken die gesamte Oberfläche der API ab. Jeder Endpunkt im Referenz-Abschnitt arbeitet mit einer von ihnen.

Dokument – eine einzelne verarbeitete Seite. Sie erstellen eines, indem Sie ein Bild oder eine PDF-Seite hochladen (ein mehrseitiger PDF-Upload erzeugt mehrere Dokumente, eines pro Seite – siehe Dokumente-Referenz). Ein Dokument durchläuft einen Statuslebenszyklus (queued → processing → succeeded / failed / canceled), der vollständig im Asynchronen Aufgabenmodell-Leitfaden erklärt wird.
Batch – eine benannte Gruppe von Dokumenten, die zusammen hochgeladen und verarbeitet werden. Jedes Dokument gehört zu genau einem Batch, identifiziert durch seinen batch_name (eine Zeichenfolge Ihrer Wahl oder eine, die die API beim Hochladen für Sie generiert). Sie starten die Verarbeitung, fragen den Status ab und rufen Ergebnisse auf Batch-Ebene ab.
Vorlage – ein gespeicherter, wiederverwendbarer Satz von Feldern, die Sie jedes Mal extrahieren möchten (z. B. eine "Lieferantenrechnung"-Vorlage mit invoice_number, vendor_name und total_amount). Vorlagen ersparen es Ihnen, dieselben Felder bei jedem process-Aufruf erneut zu deklarieren.
Feld – ein einzelner benannter Wert, den Sie aus einem Dokument extrahieren möchten (eine Rechnungsnummer, ein Datum, ein Positionsbetrag). Felder befinden sich entweder auf einer Vorlage oder können inline, einmalig, bei einem einzelnen process-Aufruf deklariert werden, ohne jemals eine Vorlage zu erstellen.

Zusammenspiel der Komponenten

Sie laden eine oder mehrere Dateien in einen Batch hoch; jeder Upload wird zu einem Dokument. Anschließend starten Sie die Verarbeitung des Batches und teilen der API mit, welche Felder Sie benötigen – entweder durch Angabe einer gespeicherten Vorlage oder durch Auflistung der Felder direkt im Anfragetext. Wenn Sie keines von beidem angeben, leitet die API selbstständig sinnvolle Spalten ab. Nach Abschluss der Verarbeitung rufen Sie die Ergebnisse des Batches ab: Jedes Dokument enthält ein line_items-Array mit Objekten, die nach Feldnamen gruppiert sind.

JSON als primäres Format

JSON ist das kanonische, vollständig unterstützte Antwortformat für jeden Endpunkt. Excel- (.xlsx) und Word-Exporte (.docx) stehen als praktischer Download auf Basis derselben Daten zur Verfügung (siehe Batches-Referenz) – sie sind kein separates Datenmodell, und API-Integrationen sollten auf dem JSON-Format aufbauen.

Authentifizierung und Zugriff

Jede v1-Anfrage wird mit einem API-Schlüssel authentifiziert, der als Authorization: Bearer <key> gesendet wird – es gibt keinen Session-Cookie-Fallback, selbst wenn Sie im selben Browser eingeloggt sind. Die v1-API steht kostenpflichtigen Tarifen zur Verfügung (Basic und höher, einschließlich Teams ab Growth); Free-Plan-Konten erhalten einen plan_required-Fehler. Informationen zum Auffinden Ihres Schlüssels finden Sie unter Umgebungseinrichtung.

Nächste Schritte

Bereit für Ihren ersten Aufruf? Der Schnellstart führt Sie durch das Abrufen eines Schlüssels, das Hochladen eines Dokuments, das Starten der Verarbeitung und das Abrufen der Ergebnisse – von Anfang bis Ende in etwa fünf Minuten. Die vollständige Liste der Endpunkte finden Sie in der API-Referenz. Wenn Sie einen KI-Coding-Assistenten für die Integration verwenden, verweisen Sie ihn direkt auf die OpenAPI 3.1-Spezifikation – es ist dasselbe Schema, das jeder Referenzseite zugrunde liegt, maschinenlesbar von Anfang bis Ende.