API-Referenz
Parse bietet zwei Wege, um Daten aus Dokumenten zu extrahieren: eine synchrone Methode mit einem einzigen Aufruf und eine asynchrone Methode in drei Schritten.
Alle Endpunkte erfordern einen Bearer-Token im Authorization-Header. Siehe Authentifizierung, um zu erfahren, wie Sie Ihren API-Schlüssel erstellen und verwenden.
Basis-URL: https://api-parse.conversiontools.io
Methode 1: Einzelaufruf (synchron)
Laden Sie eine Datei hoch und erhalten Sie das Extraktionsergebnis in einer einzigen Anfrage. Der Server verarbeitet das Dokument und liefert das Ergebnis direkt zurück. Wenn die Verarbeitung länger als das Server-Timeout dauert, erhalten Sie eine 202-Antwort mit einer Extraktions-ID zum Abfragen.
/v1/extract
Header
| Header | Wert |
|---|---|
| Authorization | Bearer YOUR_API_KEY |
| Content-Type | multipart/form-data |
Parameter (form-data)
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| file | File | Ja | Das Dokument, aus dem Daten extrahiert werden (PDF, JPEG, PNG, WebP, TIFF) |
| schema_id | String | Nein | Schema-ID, um zu steuern, welche Felder extrahiert werden |
Beispiel
curl -X POST https://api-parse.conversiontools.io/v1/extract \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "file=@invoice.pdf"Antwort (200)
{
"success": true,
"id": "ext_789...",
"filename": "invoice.pdf",
"status": "completed",
"data": {
"vendor_name": "Acme Corp",
"invoice_number": "INV-2024-001",
"date": "2024-01-15",
"total": 1650.00
},
"pages_used": 1
}Antwort (202 - Verarbeitung dauert länger)
Wenn das Dokument länger zu verarbeiten ist, liefert der Server eine 202 mit einer Extraktions-ID zurück. Fragen Sie GET /v1/extractions/:id ab, um das Ergebnis zu erhalten.
{
"success": true,
"id": "ext_789...",
"status": "processing"
}Methode 2: Upload + Extraktion (asynchron)
Ein dreistufiger Ablauf: Laden Sie zuerst die Datei hoch, starten Sie dann eine Extraktion und fragen Sie anschließend das Ergebnis ab. Diese Methode gibt Ihnen mehr Kontrolle - Sie können dieselbe hochgeladene Datei für mehrere Extraktionen mit unterschiedlichen Schemata wiederverwenden.
/v1/upload
Laden Sie ein Dokument hoch und erhalten Sie eine file_id für die Extraktion.
Parameter (form-data)
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| file | File | Ja | Das hochzuladende Dokument (PDF, JPEG, PNG, WebP, TIFF) |
Beispiel
curl -X POST https://api-parse.conversiontools.io/v1/upload \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "file=@invoice.pdf"Antwort
{
"success": true,
"file_id": "abc123...",
"filename": "invoice.pdf",
"size": 52480
}/v1/extract
Starten Sie eine Extraktion für eine hochgeladene Datei anhand ihrer file_id. Geben Sie optional eine schema_id an, um zu steuern, welche Felder extrahiert werden.
Header
| Header | Wert |
|---|---|
| Authorization | Bearer YOUR_API_KEY |
| Content-Type | application/json |
Parameter (JSON-Body)
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| file_id | String | Ja | Die vom Upload-Endpunkt zurückgegebene Datei-ID |
| schema_id | String | Nein | Schema-ID, um zu steuern, welche Felder extrahiert werden |
Beispiel
curl -X POST https://api-parse.conversiontools.io/v1/extract \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"file_id": "abc123...", "schema_id": "sch_456..."}'Antwort
{
"success": true,
"id": "ext_789...",
"status": "processing"
}/v1/extractions/:id
Rufen Sie das Ergebnis einer Extraktion ab. Fragen Sie diesen Endpunkt ab, bis status den Wert completed hat.
Beispiel
curl https://api-parse.conversiontools.io/v1/extractions/ext_789... \
-H "Authorization: Bearer YOUR_API_KEY"Antwort
{
"success": true,
"id": "ext_789...",
"filename": "invoice.pdf",
"status": "completed",
"data": {
"vendor_name": "Acme Corp",
"invoice_number": "INV-2024-001",
"date": "2024-01-15",
"items": [
{
"description": "Consulting Services",
"quantity": 10,
"unit_price": 150.00,
"amount": 1500.00
}
],
"subtotal": 1500.00,
"tax": 150.00,
"total": 1650.00,
"currency": "USD"
},
"pages_used": 1
}Export nach CSV / Excel
Wandeln Sie das Ergebnis einer abgeschlossenen Extraktion in eine Tabelle um. Exporte sind kostenlos, wiederholbar und verbrauchen keine Seiten. Verschachtelte Arrays werden denormalisiert: Kopffelder wiederholen sich in jeder Zeile, sodass die Ausgabe für Pivot-Tabellen und Importe bereit ist. Tipp: Übergeben Sie output_format (csv oder xlsx) in der Extraktionsanfrage, und der Export startet automatisch, sobald die Extraktion abgeschlossen ist.
/v1/extractions/:id/export
Starten Sie den Export. Idempotent pro Format: Wiederholte Aufrufe liefern die laufende Umwandlung oder den Status der fertigen Datei zurück.
Beispiel
curl -X POST https://api-parse.conversiontools.io/v1/extractions/ext_789.../export \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"format": "xlsx"}'Antwort
{
"success": true,
"status": "processing",
"format": "xlsx",
"progress": 0
}/v1/extractions/:id/export?format=xlsx
Fragen Sie den Export ab. Während der Umwandlung ist die Antwort JSON mit status: "processing" und einem progress-Prozentsatz. Wenn die Datei bereit ist, ist der Antworttext die Datei selbst (mit Content-Disposition: attachment).
Beispiel
curl -L -o invoice.xlsx \
"https://api-parse.conversiontools.io/v1/extractions/ext_789.../export?format=xlsx" \
-H "Authorization: Bearer YOUR_API_KEY"/v1/extractions/:id
Löschen Sie eine Extraktion und alle ihre gespeicherten Daten (Ergebnis und etwaige Exportdateien). Quelldokumente werden innerhalb von 24 Stunden nach der Verarbeitung immer automatisch gelöscht; extrahierte Ergebnisse werden gespeichert, bis Sie sie löschen - über diesen Endpunkt oder im Dashboard.
Beispiel
curl -X DELETE https://api-parse.conversiontools.io/v1/extractions/ext_789... \
-H "Authorization: Bearer YOUR_API_KEY"Fehlerantworten
401 Unauthorized
{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}429 Rate Limited
{
"success": false,
"error": {
"code": "RATE_LIMITED",
"message": "Monthly page limit exceeded",
"limit": 100,
"used": 100
}
}