Zum Hauptinhalt springen

API-Dokumentation

Integrieren Sie PDF-Analyse in Ihre Anwendungen mit unserer REST-API

API-Tokens verwalten

Ihre erste Analyse

Testen Sie eine PDF-Analyse ohne Konto. Fügen Sie ein Token hinzu, um Ihre Kontolimits zu nutzen und Ergebnisse zu speichern.

POST/api/v1/pdf/analyze
Beispiel-Anfrage
curl -X POST https://pdfcheck.online/api/v1/pdf/analyze \
  -H "Accept: application/json" \
  -F "file=@document.pdf"

Kopieren fehlgeschlagen. Markieren Sie den Code und kopieren Sie ihn manuell.

Authentifizierung
Optional
Uploadlimit
50 MB
Basis-URL
https://pdfcheck.online/api/v1

Authentifizierung

Für die PDF-Analyse ist ein Token optional. Kontodaten, gespeicherte Analysen und die Token-Verwaltung erfordern ein Bearer-Token.

Halten Sie Tokens geheim. Verwenden Sie eine Umgebungsvariable und widerrufen Sie ungenutzte Tokens in Ihrem Konto. API-Tokens verwalten

Beispiel-Anfrage
curl -X POST https://pdfcheck.online/api/v1/pdf/analyze \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PDFCHECK_API_TOKEN" \
  -F "file=@document.pdf"

Kopieren fehlgeschlagen. Markieren Sie den Code und kopieren Sie ihn manuell.

Nutzung und Limits

Ohne Konto: 10 Analysen pro Tag und IP-Adresse. Free: 100 pro Tag. Pro und AI: kein Tageslimit. Verarbeitungsendpunkte haben außerdem ein Limit von 30 Anfragen pro Minute. Analyseantworten enthalten die verbleibenden Prüfungen.

ZugriffAnalysen pro TagUploadlimit
Kein Token erforderlich1050 MB
Free10050 MB
Pro / AIKein Tageslimit100 MB

Verarbeitungsendpunkte akzeptieren außerdem bis zu 30 Anfragen pro Minute. Eine Antwort mit Status 429 kann auf ein Tages- oder Minutenlimit hinweisen.

POST/pdf/analyze

Eine PDF-Datei hochladen und analysieren. Gibt detaillierte extrahierte Metadaten zurück.

NameTypBeschreibung
filemultipart/form-dataErforderlich. PDF-Datei zur Analyse: bis zu 50 MB ohne Konto und mit Free; 100 MB mit Pro und AI.

Beispielantwort; die Werte hängen vom Dokument ab.

Beispiel-Antwort
{
    "success": true,
    "data": {
        "id": "example-analysis-token",
        "view_key": "example-view-key",
        "filename": "document.pdf",
        "file_size": 1048576,
        "file_size_formatted": "1.00 MB",
        "metadata": {
            "basic": {
                "pages": 10,
                "pdf_version": "1.7",
                "analysis_mode": "lightweight",
                "partial_analysis": true
            },
            "document": {
                "title": "Example document",
                "author": "Example author",
                "creator": "Microsoft Word",
                "producer": "Adobe PDF Library"
            }
        },
        "analyzed_at": "2026-09-29T12:00:00+00:00"
    },
    "remaining_checks": 9
}

Kopieren fehlgeschlagen. Markieren Sie den Code und kopieren Sie ihn manuell.

Die Metadatenanalyse der API verwendet einen begrenzten, ressourcenschonenden Modus. Detaillierte Schrift-, Bild- und Farbanalysen werden übersprungen; metadata.basic.partial_analysis ist true.

Metadaten und Softwaremerkmale beweisen weder Urheberschaft noch Authentizität oder die Einhaltung von Standards.

Die hochgeladenen Dateidaten werden nach der Verarbeitung gelöscht; Analyseergebnisse und Metadaten können erhalten bleiben. Siehe Datenschutzerklärung. Datenschutzerklärung

GET/user

Informationen über den authentifizierten Benutzer einschließlich täglicher Nutzungslimits abrufen.

Token erforderlich. Beispielantwort; die Werte hängen vom Dokument ab.

Beispiel-Antwort
{
    "success": true,
    "data": {
        "name": "Example user",
        "email": "user@example.com",
        "daily_limit": 100,
        "remaining_checks": 99,
        "checks_used_today": 1
    }
}

Kopieren fehlgeschlagen. Markieren Sie den Code und kopieren Sie ihn manuell.

GET/pdf

Alle PDF-Analysen für den authentifizierten Benutzer mit Paginierung auflisten.

Token erforderlich

AbfrageparameterStandardBeschreibung
per_page20Anzahl der Ergebnisse pro Seite (1-100)
page1integer
Beispiel-Antwort
{
    "success": true,
    "data": [
        {
            "id": "example-analysis-token",
            "filename": "document.pdf",
            "file_size": 1048576,
            "file_size_formatted": "1.00 MB",
            "analyzed_at": "2026-09-29T12:00:00+00:00"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 20,
        "total": 1
    }
}

Kopieren fehlgeschlagen. Markieren Sie den Code und kopieren Sie ihn manuell.

GET/pdf/{token}

Detaillierte Analyseergebnisse anhand der Analyse-ID (Freigabe-Token) abrufen.

Token erforderlich

Beispiel-Anfrage
curl https://pdfcheck.online/api/v1/pdf/example-analysis-token \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PDFCHECK_API_TOKEN"

Kopieren fehlgeschlagen. Markieren Sie den Code und kopieren Sie ihn manuell.

Endpunktreferenz

POST/pdf/extract-text

Extrahieren Sie Text aus einem PDF. Senden Sie die Datei im Feld pdf; dieser Endpunkt hat ein Uploadlimit von 50 MB und gibt data.pages zurück.

Beispiel-Anfrage
curl -X POST https://pdfcheck.online/api/v1/pdf/extract-text \
  -H "Accept: application/json" \
  -F "pdf=@document.pdf"

Kopieren fehlgeschlagen. Markieren Sie den Code und kopieren Sie ihn manuell.

POST/pdf/to-markdown

Konvertieren Sie ein PDF in Markdown. Senden Sie die Datei im Feld pdf (50 MB Limit). Separates Kontingent: 10 Konvertierungen pro Tag ohne Konto und mit Free; 100 pro Tag mit Pro und AI. Für gescannte Seiten kann externe AI-OCR verwendet werden. Die Antwort enthält remaining_conversions.

Beispiel-Anfrage
curl -X POST https://pdfcheck.online/api/v1/pdf/to-markdown \
  -H "Accept: application/json" \
  -F "pdf=@document.pdf"

Kopieren fehlgeschlagen. Markieren Sie den Code und kopieren Sie ihn manuell.

Token-Verwaltung

Das Erstellen von Tokens über die API erfordert ein vorhandenes Token. Erstellen Sie Ihr erstes Token in Ihrem Konto. API-Tokens verwalten

EndpunkteBeschreibung
GET /tokensAlle API-Tokens für den authentifizierten Benutzer auflisten.
POST /tokensEin neues API-Token erstellen. Das Token wird nur einmal in der Antwort angezeigt. name: string (max: 255)
DELETE /tokens/{tokenId}Ein API-Token dauerhaft widerrufen (löschen).
Beispiel-Anfrage
curl -X POST https://pdfcheck.online/api/v1/tokens \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PDFCHECK_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"My integration"}'

Kopieren fehlgeschlagen. Markieren Sie den Code und kopieren Sie ihn manuell.

Fehlercodes

HTTP-CodeFehlercodeBeschreibung
401Unauthenticated.Ungültiges oder fehlendes API-Token
404not_foundRessource nicht gefunden oder Zugriff verweigert
422message / errors
corrupted_pdf
password_protected
analysis_failed
Ungültige Anfrage oder fehlgeschlagene PDF-Verarbeitung, etwa bei einem nicht unterstützten Dateityp, zu großem Upload, beschädigten PDF oder Passwortschutz
429daily_limit_exceeded
message
Tages- oder Minutenlimit überschritten; versuchen Sie es erneut, sobald das betreffende Limit zurückgesetzt wird

Code-Beispiele

Lesen Sie das Ergebnis aus data.metadata.basic.pages. Alle Antwortbeispiele dienen der Veranschaulichung.

Node.js 20 oder neuer; verwendet die integrierten APIs fetch, FormData und Blob.

analyze-pdf.mjs
import { readFile } from 'node:fs/promises';

const form = new FormData();
form.append('file', new Blob([await readFile('document.pdf')], {
  type: 'application/pdf'
}), 'document.pdf');

const headers = { Accept: 'application/json' };
if (process.env.PDFCHECK_API_TOKEN) {
  headers.Authorization = `Bearer ${process.env.PDFCHECK_API_TOKEN}`;
}

const response = await fetch('https://pdfcheck.online/api/v1/pdf/analyze', {
  method: 'POST', headers, body: form
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(JSON.stringify(result));
console.log(result.data.metadata.basic.pages);
console.log(result.remaining_checks);

Kopieren fehlgeschlagen. Markieren Sie den Code und kopieren Sie ihn manuell.

Python (requests)
Python
import os
import requests

headers = {'Accept': 'application/json'}
if os.getenv('PDFCHECK_API_TOKEN'):
    headers['Authorization'] = f"Bearer {os.environ['PDFCHECK_API_TOKEN']}"

with open('document.pdf', 'rb') as pdf:
    response = requests.post(
        'https://pdfcheck.online/api/v1/pdf/analyze',
        headers=headers,
        files={'file': ('document.pdf', pdf, 'application/pdf')},
        timeout=120,
    )
response.raise_for_status()
result = response.json()
print(result['data']['metadata']['basic']['pages'])
print(result['remaining_checks'])

Kopieren fehlgeschlagen. Markieren Sie den Code und kopieren Sie ihn manuell.

PHP (cURL)
PHP
<?php
$headers = ['Accept: application/json'];
if ($token = getenv('PDFCHECK_API_TOKEN')) {
    $headers[] = 'Authorization: Bearer ' . $token;
}
$curl = curl_init('https://pdfcheck.online/api/v1/pdf/analyze');
curl_setopt_array($curl, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => ['file' => new CURLFile('document.pdf', 'application/pdf')],
]);
$body = curl_exec($curl);
if ($body === false) throw new RuntimeException(curl_error($curl));
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
$result = json_decode($body, true, flags: JSON_THROW_ON_ERROR);
if ($status >= 400 || !($result['success'] ?? false)) {
    throw new RuntimeException($body);
}
echo $result['data']['metadata']['basic']['pages'];

Kopieren fehlgeschlagen. Markieren Sie den Code und kopieren Sie ihn manuell.