Zum Hauptinhalt springen
Markdown

API Dokumentation

Die Workist-API verbindet Ihre Systeme direkt mit Workist. Über sie laden Sie Dokumente hoch, rufen verarbeitete Daten ab, melden Importergebnisse zurück und übertragen Stammdaten.

  • Basis-URL: https://api.workist.com/v1 (gleichwertig: https://api.workist.com/api/v1)
  • Swagger-Oberfläche: https://api.workist.com/v1/swagger/, mit allen Endpunkten und Schemas
  • Authentifizierung: API-Schlüssel im Header Authorization: Bearer <API-Schlüssel>

Abschnitte​

  • Quickstart: API-Schlüssel erstellen und den ersten Aufruf senden
  • Dokumenten-API: Dokumente hochladen, abrufen und das Importergebnis zurückmelden, für alle Dokumenttypen
  • Benutzung der Stammdaten-API: Stammdaten per API übertragen
  • Webhooks: Ihr System bei Ereignissen automatisch benachrichtigen

Für Entwicklung mit KI-Assistenten: KI-Assistenten — Skill und Markdown-Versionen dieser Dokumentation