Optimaite

Dokumente

3 Min. LesezeitAktualisiert 26. Mai 2026Also available in English

Die Documents API ermöglicht die programmatische Verwaltung von Dokumenten -- Dateien hochladen, Inhalte herunterladen, Dokumente Akten und Parteien zuweisen sowie Text extrahieren.

Endpunkte

MethodPathBeschreibung
GET/api/v1/documentsDokumente auflisten
POST/api/v1/documentsDokument hochladen
GET/api/v1/documents/{id}Dokument-Metadaten abrufen
GET/api/v1/documents/{id}/downloadDateiinhalt herunterladen
DELETE/api/v1/documents/{id}Dokument löschen
POST/api/v1/documents/{id}/assignAkte/Partei zuweisen
GET/api/v1/documents/{id}/partiesZugewiesene Parteien auflisten
POST/api/v1/documents/{id}/extractTextinhalt extrahieren
POST/api/v1/documents/bulk-assignDokumente in Bulk zuweisen

Erforderlicher Scope: documents:read für GET-Endpunkte, documents:write für POST/PUT, documents:delete für DELETE.

Das Dokument-Objekt

{
  "id": "doc_01ABCDEFG",
  "filename": "contract_v2.pdf",
  "mime_type": "application/pdf",
  "size_bytes": 245760,
  "status": "processed",
  "case_id": "550e8400-e29b-41d4-a716-446655440000",
  "folder_id": "fld_01ABCDEF",
  "parties": [
    { "id": "pty_01ABCDEF", "name": "John Smith", "is_primary": true }
  ],
  "extracted_text_length": 12543,
  "created_at": "2026-03-10T08:30:00Z",
  "updated_at": "2026-03-10T08:31:00Z"
}

Dokument hochladen

POST /api/v1/documents
Content-Type: multipart/form-data

Formularfelder

FieldTypeRequiredBeschreibung
fileFileYesHochzuladende Datei (PDF, DOCX, DOC, PNG, JPG, TIFF)
case_idUUIDNoSofort einer Akte zuweisen
folder_idUUIDNoIn einen bestimmten Ordner legen
party_idsstring[]NoParteien zuweisen

Beispiel

curl -X POST https://api.optimaite.eu/api/v1/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@contract.pdf" \
  -F "case_id=550e8400-e29b-41d4-a716-446655440000"

Antwort

Liefert 201 Created mit den Dokument-Metadaten.

Dokument herunterladen

GET /api/v1/documents/{id}/download

Liefert den rohen Dateiinhalt als Streaming-Response mit passenden Content-Type- und Content-Disposition-Headern.

Text extrahieren

POST /api/v1/documents/{id}/extract

Liefert den extrahierten Textinhalt eines Dokuments:

{
  "text": "This Employment Agreement (\"Agreement\") is entered into...",
  "page_count": 5,
  "word_count": 3241
}

Unterstützte Dateitypen: PDF, DOCX, DOC, Bilder (per OCR) und Plain Text.

Dokumente auflisten

GET /api/v1/documents?case_id=...&status=processed&limit=50

Query-Parameter

ParameterTypeBeschreibung
cursorstringPagination-Cursor
limitintegerErgebnisse pro Seite (1-100, Standard 50)
case_idUUIDNach Akte filtern
folder_idUUIDNach Ordner filtern
statusstringFilter: pending, processed, failed
searchstringNach Dateiname suchen

Nächste Schritte

  • Akten -- Akten für Dokumentenzuweisung verwalten
  • Signatur -- Dokumente für E-Signatur vorbereiten
Was this helpful?