API für strukturierte Datenextraktion
Der Endpunkt /ocr.json extrahiert benannte Felder aus einem Bild oder Dokument.
Der Endpunkt gibt typisiertes JSON zurück. Mit dem Abfrageparameter fields wählen Sie die Werte in der Antwort aus.
Endpunkt
POST https://api.ocrskill.com/ocr.json
Jede Anfrage benötigt ein Bearer-Token.
Authorization: Bearer sk-your-key-here
Mit diesem Befehl erhalten Sie einen kostenlosen API-Schlüssel.
curl https://api.ocrskill.com/get-key.json
Schnellstart
Fügen Sie die Feldnamen zu fields hinzu. Laden Sie anschließend eine Datei hoch.
curl "https://api.ocrskill.com/ocr.json?fields=last_name,first_name,nationality,birthdate" \
-H "Authorization: Bearer sk-your-key-here" \
-F "file=@identity-card.pdf"
Der Endpunkt gibt dieses JSON zurück.
{
"last_name": "MUSTERMANN",
"first_name": "ERIKA",
"nationality": "DEUTSCH",
"birthdate": "1964-08-12"
}
Datei senden
Der Endpunkt akzeptiert mehrteilige Uploads, Rohdateien und JSON-Daten-URIs.
Die maximale Dateigröße beträgt 20 MB.
Mehrteiliger Upload
Senden Sie die Datei im Formularfeld file, image, document oder data.
curl "https://api.ocrskill.com/ocr.json?fields=thumbnail_hook_text,video_title,video_channel" \
-H "Authorization: Bearer sk-your-key-here" \
-F "file=@thumbnail.jpg"
Binärer Rohdaten-Upload
Senden Sie die Bytes der Datei mit dem richtigen Content-Type.
curl "https://api.ocrskill.com/ocr.json?fields=company_name,invoice_date" \
-H "Authorization: Bearer sk-your-key-here" \
-H "Content-Type: application/pdf" \
--data-binary "@invoice.pdf"
JSON-Textkörper mit Daten-URI
Senden Sie ein JSON-Objekt mit einer Daten-URI in document_url (ähnlich oder kompatibel mit der Mistral-API).
curl "https://api.ocrskill.com/ocr.json?fields=title,publish_date" \
-H "Authorization: Bearer sk-your-key-here" \
-H "Content-Type: application/json" \
-d '{
"document_url": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ..."
}'
Unterstützte Dateitypen
Der Endpunkt unterstützt diese Bildtypen:
- PNG
- JPEG
- WebP
- GIF
- BMP
- TIFF
Der Endpunkt unterstützt auch diese Dokumenttypen:
- Microsoft Word (
DOCundDOCX) - Microsoft Excel (
XLSundXLSX) - Microsoft PowerPoint (
PPTundPPTX) - OpenDocument-Text-, Tabellen- und Präsentationsdateien (
ODT,ODSundODP) - RTF
- CSV
Felder auswählen
Der Parameter fields enthält eine durch Kommas getrennte Liste von Feldnamen.
Pflichtfelder
Ein Feldname ohne Suffix erfordert einen Wert. Der Endpunkt gibt 400 zurück, wenn er diesen Wert nicht findet.
?fields=last_name,first_name,birthdate
Optionale Felder
Fügen Sie ? hinzu, um ein Feld optional zu machen. Die Antwort enthält ein optionales Feld nicht, wenn der Endpunkt es nicht findet.
?fields=last_name,first_name,birthdate?,nationality?
Erkennungsmodus verwenden
Lassen Sie fields weg, um den Erkennungsmodus zu verwenden. In diesem Modus behandelt der Endpunkt alle unterstützten Felder als optional.
Die Antwort enthält nur Felder, die der Endpunkt findet.
curl "https://api.ocrskill.com/ocr.json" \
-H "Authorization: Bearer sk-your-key-here" \
-F "file=@report.docx"
Fehler behandeln
| Situation | Status | Hinweise |
|---|---|---|
Unbekannter Feldname in fields |
400 |
Der Fehler nennt das nicht unterstützte Feld. |
| Leerer Feldname | 400 |
Entfernen Sie leere Werte und abschließende Kommas. |
| Doppelter Feldname | 400 |
Führen Sie jedes Feld nur einmal auf. |
| Fehlendes Pflichtfeld | 400 |
Der Fehler enthält Extraktionsdetails und den extrahierten input_text. |
| Fehlendes oder ungültiges Bearer-Token | 401 |
Senden Sie Authorization: Bearer sk-.... |
| Nicht unterstützter oder unbekannter Dateityp | 400 |
Senden Sie einen der unterstützten Dateitypen. |
Der Endpunkt formatiert Datumsfelder als YYYY-MM-DD. Er entfernt Leerzeichen am Anfang und Ende von Zeichenfolgen.
Der Endpunkt lehnt die exakte Zeichenfolge "null" ab.
Unterstützte Felder
Sie können in einer Anfrage eine beliebige Kombination dieser Feldnamen auswählen.
Personen
| Feld | Typ | Beschreibung |
|---|---|---|
last_name |
string | Familienname oder Nachname. |
first_name |
string | Vorname. |
birthdate |
date | Geburtsdatum (YYYY-MM-DD). |
sex_gender |
string | Geschlecht. |
Adressen
| Feld | Typ | Beschreibung |
|---|---|---|
street_name |
string | Straßenname aus einer Postanschrift. |
street_number |
string | Straßen-, Gebäude- oder Hausnummer. |
address_rest |
string | Block, Eingang, Stockwerk, Wohnung oder Postfach. |
town_or_city |
string | Ort, Stadt, Gemeinde oder Ortschaft. |
county |
string | Bezirk, Kreis oder Verwaltungseinheit. |
judet |
string | Rumänischer Judet oder gleichwertige Verwaltungseinheit auf Kreisebene. |
region |
string | Region, Provinz, Bundesland oder größeres Gebiet. |
country |
string | Ländername. |
Personalausweis
| Feld | Typ | Beschreibung |
|---|---|---|
nationality |
string | Staatsangehörigkeit. |
cnp |
string | Personenkennzahl (Cod numeric personal). |
id_card_series_number |
string | Serie oder Nummer des Personalausweises. |
expiration_date |
date | Ablaufdatum des Personalausweises (YYYY-MM-DD). |
issue_date |
date | Ausstellungsdatum des Personalausweises (YYYY-MM-DD). |
id_card_issuer |
string | Name der ausstellenden Behörde. |
id_card_birth_place |
string | Geburtsort, wie er auf dem Personalausweis steht. |
Fahrzeugzulassung
| Feld | Typ | Beschreibung |
|---|---|---|
certificate_id |
string | Nummer oder Serie der Zulassungsbescheinigung. |
license_plate |
string | A: amtliches Kennzeichen oder Nummer der Fahrzeugzulassung. |
first_registration_date |
date | B: Datum der Erstzulassung (YYYY-MM-DD). |
holder_last_name |
string | C.1.1: Familienname des Halters. |
holder_company |
string | C.1.1: Firmenname des Halters. |
holder_first_name |
string | C.1.2: Vorname des Halters. |
holder_full_address |
string | C.1.3: vollständige Anschrift oder Firmensitz des Halters. |
owner_last_name |
string | C.2.1: Familienname des Eigentümers. |
owner_company |
string | C.2.1: Firmenname des Eigentümers. |
owner_first_name |
string | C.2.2: Vorname des Eigentümers. |
owner_full_address |
string | C.2.3: vollständige Anschrift oder Firmensitz des Eigentümers. |
vehicle_brand |
string | D.1: Fahrzeugmarke oder Hersteller. |
vehicle_model |
string | D.2: Typ, Variante, Version oder Modell. |
vehicle_commercial_summary |
string | D.3: Handelsbezeichnung oder Modellbeschreibung. |
vehicle_identification_number |
string | E: FIN oder Fahrgestellnummer. |
max_technical_weight |
string | F.1: technisch zulässige Gesamtmasse. |
vehicle_mass |
string | G: Masse des betriebsbereiten Fahrzeugs. |
registration_valid_until |
date | H: Ende der Zulassungsgültigkeit (YYYY-MM-DD). |
registration_date |
date | I: Zulassungsdatum (YYYY-MM-DD). |
certificate_issue_date |
date | I.1: Ausstellungsdatum der Bescheinigung (YYYY-MM-DD). |
vehicle_category |
string | J: Fahrzeugklasse. |
type_approval_number |
string | K: Typgenehmigungsnummer. |
engine_capacity |
string | P.1: Hubraum des Motors. |
engine_power |
string | P.2: maximale Nettoleistung des Motors. |
fuel_type |
string | P.3: Kraftstoffart oder Energiequelle. |
power_to_weight_ratio |
string | Q: Leistungsgewicht, falls vorhanden. |
vehicle_color |
string | R: Fahrzeugfarbe. |
seats |
string | S.1: Anzahl der Sitzplätze, einschließlich Fahrersitz. |
standing_places |
string | S.2: Anzahl der Stehplätze, falls vorhanden. |
vehicle_identification_series |
string | Y: Serie des Fahrzeugbriefs. |
certificate_issuer |
string | Z: Name der ausstellenden Behörde. |
last_itp_date |
date | Datum der letzten regelmäßigen technischen Untersuchung (YYYY-MM-DD). |
Unternehmen, Rechnungen und Belege
| Feld | Typ | Beschreibung |
|---|---|---|
company_name |
string | Name des Unternehmens, der Organisation oder der juristischen Person. |
buyer_name |
string | Name des Käufers. |
seller_name |
string | Name des Verkäufers. |
total_amount |
number | Gesamter in Rechnung gestellter oder bezahlter Betrag. |
invoice_date |
date | Ausstellungsdatum der Rechnung. |
receipt_date |
date | Ausstellungsdatum des Belegs. |
Schriftliche Werke
| Feld | Typ | Beschreibung |
|---|---|---|
title |
string | Titel des Artikels. |
sub_title |
string | Untertitel des Artikels. |
article_abstract |
string | Abschnitt mit Kurzfassung oder Zusammenfassung des Artikels. |
article_body |
string | Haupttext des Artikels. |
publish_date |
date | Veröffentlichungsdatum des Inhalts (YYYY-MM-DD). |
article_tags |
string | Durch Kommas getrennte Schlagwörter des Inhalts. |
tags |
string | Durch Kommas getrennte Schlagwörter des Inhalts. |
concise_summary |
string | Kurze Zusammenfassung des Inhalts. Das System erstellt sie neu, falls keine vorhanden ist. |
Veranstaltungen
| Feld | Typ | Beschreibung |
|---|---|---|
event_name |
string | Name oder Titel der Veranstaltung. |
event_venue |
string | Veranstaltungsort, Standort oder Standorte. |
event_dates |
string | Datum oder Zeitraum der Veranstaltung in Textform. |
event_date |
date | Datum oder unvollständiges Datum der Veranstaltung (YYYY-MM-DD). |
Video-Miniaturbilder
| Feld | Typ | Beschreibung |
|---|---|---|
thumbnail_hook_text |
string | Aufhängertext des Videos oder Clips, genau wie geschrieben. |
video_title |
string | Titel des Videos oder Clips. |
video_channel |
string | Kanalname des Erstellers. |
video_length_str |
string | Länge des Videos oder Clips, genau wie geschrieben. |
date_posted_str |
string | Veröffentlichungsdatum, genau wie geschrieben. |
Als Markdown statt als strukturiertes JSON extrahieren
Verwenden Sie den Endpunkt /ocr, wenn Sie Markdown statt strukturierter Felder benötigen. Er akzeptiert dieselben Dateitypen.
curl https://api.ocrskill.com/ocr \
-H "Authorization: Bearer sk-your-key-here" \
-F "file=@example.pdf"
Häufig gestellte Fragen
Was sind strukturierte Daten?
Strukturierte Daten verwenden benannte Felder und einheitliche Typen. Der Endpunkt /ocr.json gibt Zeichenfolgen, Zahlen und Datumswerte zurück, die Ihre Anwendung direkt lesen kann.
Handelt es sich um strukturierte Daten von Google oder schema.org-Markup?
Nein. Strukturierte Daten von Google beschreiben Webseiten für Suchmaschinen. Sie verwenden JSON-LD oder Mikrodaten auf einer Webseite.
OCRskill extrahiert typisiertes JSON aus Dateien. Ihre Anwendung kann dieses JSON speichern oder verarbeiten.
Hat die Ausgabe ein JSON-Schema?
Ja. OCRskill erstellt das Antwortschema aus den angeforderten fields.
Datumsfelder verwenden YYYY-MM-DD. Jedes Feld in dieser Referenz entspricht einer typisierten JSON-Eigenschaft.
Kann ich PDF in JSON, Bild in PDF oder PDF in Bild umwandeln?
Sie können ein PDF direkt an /ocr.json senden. Sie müssen die Seiten nicht in Bilder umwandeln.
OCRskill wandelt keine Bilder in PDFs und keine PDFs in Bilder um.
Wie extrahiere ich Text aus einem Bild (Bild zu Text)?
Rufen Sie /ocr auf, um Markdown zu extrahieren. Rufen Sie /ocr.json mit fields auf, um benannte Werte zu extrahieren.
Kann ich ein Bild in einen Prompt umwandeln (Bild zu Prompt)?
Rufen Sie /ocr auf, um Markdown für einen Prompt zu extrahieren. Verwenden Sie /ocr.json, wenn der Prompt nur bestimmte Werte benötigt.
Warum ist die Extraktion fehlgeschlagen?
Der Endpunkt gibt 400 zurück, wenn er eine Extraktion nicht abschließen kann. Lesen Sie die Fehlermeldung, um die Ursache zu ermitteln.
Häufige Ursachen sind ein fehlendes Pflichtfeld, ein unbekanntes Feld, ein doppeltes Feld oder ein nicht unterstützter Dateityp.
Der Fehler enthält auch input_text. Prüfen Sie mit diesem Wert den von OCRskill extrahierten Text vor dem Fehler der strukturierten Extraktion.
Kann ich OCRskill mit Claude verwenden?
Ja. Extrahieren Sie mit OCRskill Markdown oder JSON. Senden Sie das Ergebnis anschließend an Claude.