API-Dokumentation

API-Referenz

Vollständige Dokumentation für alle Public Safety-APIs einschließlich GraphQL-, REST- und WebSocket-Endpunkten. Alle Endpunkte benötigen einen gültigen argus_auth_token, um Daten zurückzugeben.

Reference posture

Start in the auth lane, move requests through the operational API, and keep realtime and audit controls visible from the same reference surface.

Auth endpoints

80+

REST endpoints

130+

GraphQL operations

180+

Realtime subscriptions

WS

API operating model

The auth lane, casework lane, and realtime lane are documented as one operating surface

Public Safety Command Center stellt zwei primäre API-Services mit über 200 REST-Endpunkten und 180+ GraphQL-Operationen bereit. Alle authentifizierten Endpunkte benötigen einen gültigen argus_auth_token, der über den Auth-Service bezogen wird.

auth.knogin.com

Auth-Service

Verwaltet alle Authentifizierung, Benutzerverwaltung, MFA, SSO, API-Schlüssel, Rollen, Berechtigungen und Sitzungsverwaltung. Hier erhalten Sie Token für den Zugriff auf den API-Service.

Surface

80+ Endpunkte

Identity lane

OAuth2/OIDC

Operator assurance

TOTP/Passkey/Voice MFA

api.knogin.com

API-Service

Die zentrale Intelligence-Plattform-API mit REST-Endpunkten und GraphQL für Ermittlungen, Vorgänge, Profile, Beweise, Alarme, Monitore, KI-Services und Echtzeitkommunikation.

REST lane

130+ REST-Endpunkte

Graph surface

180+ GraphQL-Operationen

Realtime lane

WebSocket

Basis-URLs

Base URLs and deployment lanes

Use the production lane for live workloads and the staging lane for validation, connector certification, and client rollout rehearsals.

Auth-Service (Produktion)

https://auth.knogin.com

API-Service (Produktion)

https://api.knogin.com

Auth-Service (Staging)

https://auth-staging.knogin.com

API-Service (Staging)

https://api-staging.knogin.com

Authentifizierung

Authentication handshake

Alle authentifizierten API-Anfragen benötigen einen gültigen argus_auth_token. Token werden über den Auth-Service bezogen und müssen in allen nachfolgenden Anfragen an beide Services enthalten sein. API-Schlüssel können im Auth-Service-Dashboard unter Ihrem Benutzerprofil für programmatischen Zugriff generiert werden.

Beispiel: Login mit Zugangsdaten (Auth-Service)
curl -X POST https://auth.knogin.com/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"api_key":"your_api_key","platform":"publicSafety"}'

# Response
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "expires_in": 3600
}

Product context

Investigation workspace

The same investigation state exposed to analysts is what the API and GraphQL layers need to describe accurately.

Analysis context

Graph and relationship state

Graph and realtime endpoints should map directly to the linked entity and workflow state teams review in the product.

Request flow

Keep the request path explicit so identity, ingest, and oversight teams are reading the same contract

The fastest way to make an API page feel synthetic is to dump endpoints without showing how the lanes fit together. This flow keeps the operational order clear.

  1. 1

    Mint access in the auth lane

    Issue short-lived access tokens, enforce MFA or passkey policy, and scope platform access before a client is allowed near investigative data.

  2. 2

    Submit data and workflow requests

    Move ingestion, enrichment, graph, evidence, and reporting calls through the API lane with the same token and RBAC posture.

  3. 3

    Subscribe to operational state

    Use GraphQL subscriptions or event streams when teams need live alerts, workflow updates, and collaboration signals without polling loops.

  4. 4

    Audit every access path

    Keep response envelopes, rate limits, and audit proofs visible so integration teams know what is reviewable in production and court-facing workflows.

Common headers

Browser and service clients use different transport shapes

Browser clients normally hold HTTP-only cookies. Server clients carry bearer tokens. Both end up under the same audit and rate-limit controls.

Auth headers
Authorization: Bearer <argus_auth_token>
Cookie: platform_access_token=<jwt>; knogin_refresh_token=<jwt>

AUTH-SERVICE

Auth-Service-Endpunkte

Der Auth-Service (auth.knogin.com) verwaltet alle Authentifizierung, Autorisierung, Benutzerverwaltung, MFA, SSO, API-Schlüssel, Rollen, Berechtigungen, Feature Flags und Multi-Tenant-Verwaltung. Er enthält 80+ Endpunkte, organisiert nach Funktionalität.

Token- & Sitzungsverwaltung

Zentrale Authentifizierungsendpunkte zum Erhalten, Erneuern und Verwalten von Zugriffstoken und Sitzungen.

POST
/v1/token

Login mit Zugangsdaten (OAuth2-Formular)

OAuth2-kompatibler Login-Endpunkt, der formular-kodierte E-Mail und Passwort akzeptiert. Gibt plattformspezifische Zugriffstoken aus und setzt HTTP-only-Cookies (platform_access_token, knogin_refresh_token) für Browser-Sitzungen. Vorgangs MFA aktiviert ist, wird stattdessen ein Challenge-Cookie zurückgegeben, das eine Verifizierung über /v1/mfa/verify-login erfordert. Unterstützt redirect_uri für Post-Login-Navigation.

Öffentlich5/min
POST
/v1/auth/token

Login mit API-Schlüssel

Authentifizierung mit einem API-Schlüssel zum Erhalt eines plattformspezifischen JWT-Tokens. Ideal für Service-zu-Service-Authentifizierung, CI/CD-Pipelines und programmatischen Zugriff. API-Schlüssel können im Auth-Service-Dashboard unter Ihrem Benutzerprofil generiert werden. Request-Body erfordert api_key- und platform-Felder.

Öffentlich
POST
/v1/auth/refresh

Zugriffstoken erneuern

Erneuert abgelaufene Zugriffstoken mithilfe des knogin_refresh_token-Cookies. Gibt neue Zugriffstoken-Cookies zurück, ohne erneute Authentifizierung zu erfordern. Unterstützt optionalen Plattform-Pfadparameter für plattformspezifische Token-Erneuerung. Essentiell zur Aufrechterhaltung langlebiger Sitzungen in Browser-Anwendungen.

Öffentlich
POST
/v1/auth/logout

Logout & Sitzung beenden

Beendet die aktuelle Benutzersitzung durch Invalidierung aller Token und Löschung der Authentifizierungs-Cookies. Entfernt die Sitzung aus dem serverseitigen Sitzungsspeicher. Unterstützt optionalen Plattform-Pfadparameter. Gibt 204 No Content bei Erfolg zurück.

Auth erforderlich
POST
/v1/auth/revoke-user-sessions/{user_id}

Alle Benutzersitzungen widerrufen (Admin)

Beendet zwangsweise alle aktiven Sitzungen für einen bestimmten Benutzer über alle Geräte und Plattformen hinweg. Wird bei Sicherheitsvorfällen oder wenn der Zugriff eines Benutzers sofort widerrufen werden muss, verwendet. Gibt die Anzahl widerrufener Sitzungen zurück. Erfordert Admin- oder Superuser-Rolle.

Admin/Superuser

Benutzerprofil & Self-Service

Endpunkte für Benutzer zur Verwaltung ihrer eigenen Profile, Anzeige ihrer Informationen und Aktualisierung ihrer Einstellungen.

GET
/v1/users/me

Aktuelles Benutzerprofil abrufen

Gibt das vollständige Profil des aktuell authentifizierten Benutzers zurück, einschließlich E-Mail, Anzeigename, Organisation, Rollen, Berechtigungen, MFA-Status, Erstellungsdatum und letztem Login-Zeitstempel. Wird von Frontend-Anwendungen verwendet, um Benutzer-Dashboards zu befüllen und Berechtigungen zu überprüfen.

Auth erforderlich
PUT
/v1/users/me

Eigenes Profil aktualisieren

Ermöglicht Benutzern, ihre eigenen Profilinformationen einschließlich Anzeigename, Telefonnummer und Passwort zu aktualisieren. Bei Passwortänderung werden alle anderen Sitzungen aus Sicherheitsgründen automatisch beendet. Erfordert aktuelle Passwort-Verifizierung für sensible Änderungen.

Auth erforderlich
GET
/v1/auth/me

Profil mit Feature Flags abrufen

Gibt das aktuelle Benutzerprofil zusammen mit ausgewerteten Feature Flags für den Tenant des Benutzers und benutzerspezifische Überschreibungen zurück. Wird von Frontend-Anwendungen verwendet, um zu bestimmen, welche Features basierend auf dem Abonnement-Tier des Benutzers und aktivierten Experimenten angezeigt werden sollen.

Auth erforderlich
POST
/v1/users/create

Selbstregistrierung

Öffentlicher Endpunkt für neue Benutzer zur Kontoerstellung. Akzeptiert E-Mail und Passwort, erstellt den Benutzer im System und sendet eine Verifizierungs-E-Mail. Rate-limitiert auf 2 Anfragen pro Stunde pro IP, um Missbrauch zu verhindern. Gibt das erstellte Benutzerobjekt zurück.

Öffentlich2/hour

Multi-Faktor-Authentifizierung (MFA)

Umfassende MFA-Unterstützung einschließlich TOTP (Authentifikator-Apps), WebAuthn-Passkeys und Sprachverifizierung. Benutzer können mehrere Methoden für mehrschichtige Sicherheit aktivieren.

POST
/v1/portal/mfa/totp/enable

TOTP aktivieren - Secret generieren

Generiert ein neues TOTP-Secret und gibt es zusammen mit einem QR-Code-Bild (base64-kodiert) zum Scannen mit Authentifikator-Apps wie Google Authenticator, Authy oder 1Password zurück. Das Secret wird im Pending-Status gespeichert, bis es verifiziert wird.

Auth erforderlich
POST
/v1/portal/mfa/totp/verify-and-activate

TOTP verifizieren und aktivieren

Verifiziert einen TOTP-Code aus der Authentifikator-App des Benutzers und aktiviert TOTP-MFA für dessen Konto. Erfordert den 6-stelligen Code aus der Authentifikator-App. Nach Aktivierung wird TOTP für alle zukünftigen Logins erforderlich.

Auth erforderlich
POST
/v1/mfa/verify-login

MFA während Login verifizieren

Validiert den MFA-Code (TOTP) während des Login-Challenge-Flows. Wird nach initialem Login aufgerufen, wenn MFA erforderlich ist. Erfordert das TF_AUTH-Challenge-Cookie und den 6-stelligen TOTP-Code. Bei Erfolg werden vollständige Zugriffstoken ausgegeben.

Öffentlich5/min
POST
/v1/portal/mfa/passkey/generate-registration

Passkey-Registrierungsoptionen generieren

Generiert WebAuthn-Registrierungsoptionen zum Erstellen neuer Passkey-Credentials. Gibt Challenge, Relying-Party-Info und unterstützte Algorithmen zurück. Wird von der WebAuthn-API des Browsers (navigator.credentials.create) zum Erstellen eines neuen Passkeys verwendet.

Auth erforderlich
POST
/v1/portal/mfa/passkey/verify-registration

Passkey verifizieren und speichern

Verifiziert die WebAuthn-Attestation-Response vom Browser und speichert den neuen Passkey-Credential. Speichert den öffentlichen Schlüssel, Credential-ID und Metadaten. Benutzer können mehrere Passkeys für verschiedene Geräte registrieren.

Auth erforderlich
POST
/v1/portal/mfa/voice/enroll

Sprachprofil registrieren

Registriert eine Sprachprobe für sprachbasierte MFA. Akzeptiert base64-kodierte Audiodaten des Benutzers, der eine Passphrase spricht. Der Stimmabdruck wird verarbeitet und für zukünftige Verifizierung gespeichert. Erfordert mehrere Proben für genaue Registrierung.

Auth erforderlich

Single Sign-On (SSO)

OAuth2/OIDC-basierte Single-Sign-On-Integration mit Enterprise-Identity-Providern einschließlich Google Workspace und Microsoft Entra ID (Azure AD).

GET
/v1/portal/sso/available-providers

Verfügbare SSO-Provider auflisten

Gibt eine Liste der für den aktuellen Tenant konfigurierten SSO-Provider zurück. Response enthält Providernamen und Anzahl. Wird von Login-UI verwendet, um verfügbare SSO-Login-Schaltflächen anzuzeigen (z.B. 'Mit Google anmelden', 'Mit Microsoft anmelden').

Öffentlich
GET
/v1/portal/login/{provider}

SSO-Login initiieren

Initiiert den OAuth2/OIDC-Autorisierungsfluss mit dem angegebenen Identity-Provider. Leitet den Benutzer zur Login-Seite des Providers (Google, Microsoft) um. Akzeptiert redirect_uri für Post-Login-Navigation.

Öffentlich
GET
/v1/portal/auth/{provider}

SSO-Callback-Handler

OAuth2/OIDC-Callback-Endpunkt, der den vom Identity-Provider zurückgegebenen Autorisierungscode verarbeitet. Tauscht Code gegen Token aus, erstellt oder aktualisiert Benutzerkonto und etabliert Sitzung mit Cookies.

Öffentlich

API-Schlüsselverwaltung

Erstellen und verwalten Sie API-Schlüssel für programmatischen Zugriff. API-Schlüssel können auf bestimmte Plattformen beschränkt und mit konfigurierbarem Ablauf versehen werden.

POST
/v1/portal/users/me/keys

API-Schlüssel erstellen

Erstellt einen neuen API-Schlüssel für programmatischen Zugriff. Der vollständige Schlüssel wird nur einmal bei Erstellung zurückgegeben - speichern Sie ihn sicher. Unterstützt Plattform-Scoping und optionales Ablaufdatum. Gibt Schlüsselpräfix zur Identifikation zurück.

Auth erforderlich
GET
/v1/portal/users/me/keys

API-Schlüssel auflisten

Gibt alle API-Schlüssel für den aktuellen Benutzer zurück. Zeigt Schlüsselpräfix, Erstellungsdatum, Datum der letzten Verwendung und zugeordnete Plattformen. Gibt aus Sicherheitsgründen nicht den vollständigen Schlüsselwert zurück.

Auth erforderlich
DELETE
/v1/portal/users/me/keys/{key_id}

API-Schlüssel widerrufen

Widerruft dauerhaft einen API-Schlüssel und invalidiert sofort alle mit diesem Schlüssel ausgestellten Token. Alle Anwendungen, die diesen Schlüssel verwenden, verlieren sofort den Zugriff. Kann nicht rückgängig gemacht werden.

Auth erforderlich

Benutzerverwaltung (Admin)

Administrative Endpunkte zur Verwaltung von Benutzern, Rollen und Berechtigungen. Der Zugriff variiert je nach Rollenhierarchie.

GET
/v1/portal/admin/users

Benutzer auflisten

Gibt alle Benutzer basierend auf der Rolle des Aufrufers zurück. Manager sehen nur Benutzer in ihrer Organisation. Superuser sehen alle Benutzer über alle Organisationen hinweg. Unterstützt Paginierung und Filterung nach Rolle, Status und Organisation.

Admin/Manager
POST
/v1/portal/admin/users

Benutzer erstellen

Erstellt einen neuen Benutzer mit angegebener E-Mail, Passwort, Rollen und Organisationszuweisung. Sendet optional Willkommens-E-Mail. Kann initialen Plattformzugriff und Sicherheitsfreigabe-Level zuweisen. Nur Superuser.

Admin/Superuser
PUT
/v1/portal/admin/users/{user_id}

Benutzer aktualisieren

Aktualisiert Benutzerdetails einschließlich Rollen, Berechtigungen, Plattformzugriff und Sicherheitsfreigabe. Kann Benutzer aktivieren/deaktivieren. Rollenänderungen werden bei nächster Token-Erneuerung wirksam. Nur Superuser für organisationsübergreifende Änderungen.

Admin/Superuser
PATCH
/v1/users/{user_id}/permissions

Benutzerberechtigungen aktualisieren

Aktualisiert granulare Berechtigungen eines Benutzers unabhängig von seinen rollenbasierten Berechtigungen. Ermöglicht Feinabstimmung der Zugriffskontrolle. Nur Admin oder Superuser. Gibt aktualisierte Berechtigungsmenge zurück.

Admin/Superuser

Rollen- & Berechtigungsverwaltung

Definieren Sie benutzerdefinierte Rollen und granulare Berechtigungen für fein abgestimmte Zugriffskontrolle innerhalb von Organisationen.

GET
/v1/roles

Verfügbare Rollen auflisten

Gibt alle im System verfügbaren Rollen zurück, einschließlich integrierter Rollen (Admin, Manager, Analyst, Viewer) und benutzerdefinierter Rollen für die Organisation. Enthält mit jeder Rolle verknüpfte Berechtigungen.

Öffentlich
POST
/v1/roles

Benutzerdefinierte Rolle erstellen

Erstellt eine neue benutzerdefinierte Rolle mit angegebenen Berechtigungen. Benutzerdefinierte Rollen erweitern die integrierte Rollenhierarchie. Nur Superuser. Rollennamen müssen innerhalb der Organisation eindeutig sein.

Admin/Superuser
PUT
/v1/roles/{role_id}

Rolle aktualisieren

Aktualisiert Namen, Beschreibung oder Berechtigungen einer benutzerdefinierten Rolle. Änderungen betreffen alle Benutzer mit dieser Rolle bei ihrer nächsten Token-Erneuerung. Kann integrierte Rollen nicht ändern. Nur Superuser.

Admin/Superuser
DELETE
/v1/roles/{role_id}

Benutzerdefinierte Rolle löschen

Löscht eine benutzerdefinierte Rolle. Benutzer mit dieser Rolle verlieren zugeordnete Berechtigungen. Kann keine Rollen löschen, die aktuell Benutzern zugewiesen sind. Kann integrierte Rollen nicht löschen. Nur Superuser.

Admin/Superuser

Feature Flags

Steuern Sie die Verfügbarkeit von Features auf Tenant- und Benutzerebene für schrittweise Rollouts und A/B-Tests.

GET
/v1/feature-flags/tenant

Tenant-Feature-Flags abrufen

Gibt alle Feature Flags und deren Werte für den aktuellen Tenant zurück. Dies sind die Basis-Flags, die für alle Benutzer in der Organisation gelten, sofern nicht auf Benutzerebene überschrieben.

Admin/Manager
PUT
/v1/feature-flags/tenant

Tenant-Feature-Flags aktualisieren

Aktualisiert Feature Flags für den Tenant. Änderungen gelten für alle Benutzer in der Organisation, sofern sie keine Benutzerebenen-Überschreibungen haben. Wird verwendet, um Features für die gesamte Organisation zu aktivieren/deaktivieren.

Admin/Manager
GET
/v1/feature-flags/user/{user_id}

Benutzer-Feature-Flag-Überschreibungen abrufen

Gibt benutzerspezifische Feature-Flag-Überschreibungen zurück. Diese überschreiben Tenant-Level-Flags für einzelne Benutzer. Wird für Beta-Tests mit bestimmten Benutzern oder Bereitstellung von Premium-Features für ausgewählte Konten verwendet.

Admin/Manager
PUT
/v1/feature-flags/user/{user_id}

Benutzer-Feature-Flag-Überschreibungen aktualisieren

Setzt benutzerspezifische Feature-Flag-Überschreibungen. Überschreibungen können nur eine Teilmenge der Organisationsflags sein - kann keine Flags aktivieren, die für den Tenant nicht verfügbar sind. Gibt aktualisierte Benutzer-Flags zurück.

Admin/Manager

Multi-Tenant- & Systems-Integrator-Verwaltung

Verwalten Sie die Multi-Tenant-Hierarchie einschließlich Systems Integrators (SI), die Public Safety-Deployments für ihre Kunden weiterverkaufen und verwalten.

POST
/v1/systems-integrators

Systems Integrator erstellen

Erstellt eine neue Systems-Integrator-Organisation, die mehrere Kunden-Tenants verwalten kann. Nur Vectis Consilium-Admin. SI erhält eigenes Admin-Portal und kann Kunden-Deployments erstellen/verwalten.

Vectis Consilium-Admin
GET
/v1/systems-integrators/{si_id}/customers

SI-Kunden auflisten

Gibt alle von einem Systems Integrator verwalteten Kunden-Tenants zurück. SI-Admins können nur ihre eigenen Kunden anzeigen. Enthält Tenant-Status, Benutzeranzahl und Feature-Aktivierung.

SI-Admin
POST
/v1/systems-integrators/{si_id}/customers

Kunden-Tenant erstellen

Erstellt einen neuen Kunden-Tenant unter einem Systems Integrator. Der SI wird zur verwaltenden Entität für Abrechnung und Support. Konfiguriert initiale Features basierend auf dem Abonnement-Tier des SI.

SI-Admin
PUT
/v1/tenants/{tenant_id}

Tenant aktualisieren

Aktualisiert Tenant-Konfiguration einschließlich Name, Features, Kontingente und Metadaten. Wird verwendet, um Features zu aktivieren/deaktivieren oder Ressourcenlimits für einen Kunden anzupassen.

SI-Admin

Utility & Konfiguration

Administrative Konfigurations- und Utility-Endpunkte.

GET
/v1/portal/admin/config

Admin-Konfiguration abrufen

Gibt Konfigurationsdaten für die Admin-UI zurück, einschließlich verfügbarer Rollen, Berechtigungskatalog, Länderliste, unterstützte Plattformen und Feature-Verfügbarkeit. Wird verwendet, um Admin-Dashboard-Dropdowns und Formulare zu befüllen.

Admin/Manager
GET
/v1/portal/data/countries

Länderliste abrufen

Gibt eine Liste aller Länder mit ihren Regionen/Bundesstaaten für Adressformulare zurück. Enthält ISO-Codes, Namen und Unterteilungen. Öffentlicher Endpunkt für Registrierungs- und Profilformulare.

Öffentlich
GET
/health

Health Check

Einfacher Health-Check-Endpunkt, der Servicestatus zurückgibt. Wird von Load Balancern und Überwachungssystemen verwendet. Gibt status: healthy, service: auth_service zurück.

Öffentlich
GET
/audit/logs

Audit-Logs abrufen

Gibt Sicherheits-Audit-Logs für den Authentifizierungsservice zurück. Enthält Login-Versuche, Berechtigungsänderungen und administrative Aktionen. Administrator mit Audit-Berechtigung erforderlich.

Administrator

API-SERVICE

API-Service-Endpunkte

Der API-Service (api.knogin.com) ist die zentrale Intelligence-Plattform mit 130+ REST-Endpunkten für Ermittlungen, Vorgänge, Profile, Beweise, Alarme, KI-Services, Echtzeitkommunikation und mehr. Alle Endpunkte erfordern Authentifizierung, sofern nicht als öffentlich gekennzeichnet.

Health & Systemfähigkeiten

System-Health-Monitoring und Endpunkte zur Erkennung von Fähigkeiten für Integration und Überwachung.

GET
/api/v1/health

Umfassender Health Check

Gibt detaillierten Health-Status aller Systemkomponenten zurück, einschließlich Neo4j-Graph-Datenbank, PostgreSQL-Relationsdatenbank, Redis-Cache, KI-Services (OpenAI, Anthropic, Google AI) und externe Integrationen. Response enthält Latenzmetriken und Verbindungsstatus für jede Komponente. Wird für Operations-Monitoring und Incident Response verwendet.

Öffentlich
GET
/api/v1/health/simple

Einfacher Health Check

Leichtgewichtiger Health Check mit minimaler Response für Load Balancer und Orchestrierungssysteme (Kubernetes, Cloud Run). Gibt 200 OK zurück, wenn Service läuft. Prüft keine Downstream-Abhängigkeiten für schnellere Antwortzeit.

Öffentlich
GET
/api/v1/health/connectivity

Externe Service-Konnektivität

Prüft Konnektivität zu allen externen Services einschließlich KI-Provider, OSINT-Datenquellen, Speichersysteme und Benachrichtigungsservices. Gibt detaillierten Status für jeden Integrationspunkt zurück.

Öffentlich
GET
/api/v1/capabilities

Systemfähigkeiten

Gibt umfassende Systemfähigkeiten für Frontend-Konfiguration zurück, einschließlich unterstützter Domänen, verfügbarer OSINT-Provider, akzeptierter Dateiformate, API-Endpunkte, aktivierter Features, Rate-Limits und maximaler Dateigrößen. Essentiell für dynamische UI-Konfiguration.

Öffentlich

Intelligence-Verarbeitung

KI-gestützte Dokumentenverarbeitung zur Extraktion von Entitäten, Beziehungen und Intelligence aus Text-, Bild-, Audio- und Videodateien.

POST
/api/v1/intelligence/process-text

Textdokument verarbeiten

Laden Sie Text-, PDF- oder DOCX-Dateien für Ermittlungen hoch und verarbeiten Sie sie. Verwendet KI zur Extraktion von Entitäten (Personen, Organisationen, Standorte), Beziehungen, Ereignissen und wichtiger Intelligence aus Dokumenten. Unterstützt Dateien bis 50MB. Ergebnisse werden gespeichert und mit der Ermittlung verknüpft.

Auth erforderlich
POST
/api/v1/process-image-file

Bild verarbeiten

Laden Sie Bilder für KI-gestützte visuelle Analyse hoch und verarbeiten Sie sie. Führt OCR-Textextraktion, Objekterkennung, Gesichtserkennung, Standortidentifikation und Szenenklassifizierung durch. Unterstützt JPEG-, PNG-, GIF- und WebP-Formate.

Auth erforderlich
POST
/api/v1/process-audio-file

Audio verarbeiten

Laden Sie Audiodateien für Transkription und Sprechererkennung hoch und verarbeiten Sie sie. Verwendet fortgeschrittene Speech-to-Text und Speaker Diarization. Unterstützt MP3-, WAV-, OGG- und M4A-Formate bis 100MB.

Auth erforderlich
POST
/api/v1/process-video-file

Video verarbeiten

Laden Sie Videodateien für umfassende Analyse hoch und verarbeiten Sie sie. Extrahiert Audio-Transkription, erkennt Gesichter über Frames hinweg, identifiziert Szenen und Objekte und generiert visuelle Timeline. Unterstützt MP4, MOV, AVI, WebM bis 500MB.

Auth erforderlich

Profilverwaltung

Erstellen, aktualisieren und anreichern Sie Entitätsprofile mit Daten von OSINT-Providern. Unterstützt Einzel- und Batch-Operationen.

POST
/api/v1/profiles

Profil erstellen

Erstellt ein neues Entitätsprofil (Person, Organisation, Fahrzeug, etc.). Akzeptiert initiale Daten und validiert/normalisiert Felder automatisch. Löst Hintergrund-Anreicherung aus, wenn auto_enrich aktiviert ist.

Auth erforderlich
GET
/api/v1/profiles/{profile_id}

Profil abrufen

Gibt vollständige Profildaten zurück, einschließlich aller Attribute, verknüpfter Entitäten, Timeline und Anreicherungsdaten. Unterstützt Feldauswahl zur Performance-Optimierung.

Auth erforderlich
POST
/api/v1/profiles/{profile_id}/enrich

Profil anreichern

Reichert ein Profil mit Daten von OSINT-Providern an. Optional können Sie angeben, welche Provider verwendet werden sollen (Social, Criminal, Financial, etc.). Gibt aggregierte Daten zurück, einschließlich Social-Media-Präsenz, öffentlicher Aufzeichnungen und Open-Source-Intelligence.

Auth erforderlich
POST
/api/v1/batch/enrich

Batch-Profil-Anreicherung

Reichert mehrere Profile in einer einzigen Anfrage an. Maximal 10 Profile pro Anfrage zur Verwaltung von Provider-Rate-Limits. Gibt individuellen Erfolgs-/Fehlerstatus für jedes Profil zurück.

Auth erforderlich

Ermittlungen & Vorgänge

Verwalten Sie Ermittlungen, Vorgänge, Aufgaben und den gesamten Ermittlungslebenszyklus.

POST
/api/v1/investigations

Ermittlung erstellen

Erstellt einen neuen Ermittlungsarbeitsbereich mit Titel, Beschreibung und Klassifizierungsstufe. Weist automatisch den Ersteller als leitenden Ermittler zu. Gibt Ermittlungs-ID für nachfolgende Operationen zurück.

Auth erforderlich
GET
/api/v1/investigations/{investigation_id}

Ermittlung abrufen

Gibt vollständige Ermittlungsdetails zurück, einschließlich Metadaten, Teammitgliedern, Vorgängen, Profilen, Dateien und Aktivitäts-Timeline. Unterstützt Feldauswahl für große Ermittlungen.

Auth erforderlich
GET
/api/v1/investigations

Ermittlungen auflisten

Gibt für den aktuellen Benutzer zugängliche Ermittlungen zurück. Unterstützt Filterung nach Status, Datum, Teammitglied und Suchanfrage. Paginiert mit Sortieroptionen.

Auth erforderlich
POST
/api/v1/investigations/{investigation_id}/files

Dateien zu Ermittlung hinzufügen

Verknüpft hochgeladene Dateien mit einer Ermittlung. Dateien werden basierend auf Typ automatisch für KI-Verarbeitung in die Warteschlange gestellt. Löst Indizierung für Suche aus.

Auth erforderlich

Alarme & Monitore

Konfigurieren Sie Überwachungsregeln und verwalten Sie Alarme, die durch Echtzeit-Datenströme ausgelöst werden.

POST
/api/v1/alerts

Erstellen Alarm

Erstellt programmatisch einen Alarm. Typischerweise werden Alarme von Monitoren erstellt, aber manuelle Erstellung wird für Integrationen unterstützt. Erfordert Titel, Schweregrad und mindestens eine Entitätsreferenz.

Auth erforderlich
POST
/api/v1/alerts/{alert_id}/decide

Alarm entscheiden

Erfasst eine Entscheidung zu einem Alarm: eskalieren, untersuchen, verwerfen oder Falschmeldung. Entscheidung enthält Begründung und optionale Entitätsdisposition. Geschlossene Alarme können Folge-Workflows auslösen.

Auth erforderlich
POST
/api/v1/monitors

Erstellen Monitor

Erstellt eine Überwachungsregel, die Alarme basierend auf Datenstream-Mustern auslöst. Unterstützt komplexe Bedingungen mit Entitäts-Matching, geografischen Grenzen, zeitlichen Mustern und Schwellenwert-Triggern.

Auth erforderlich
POST
/api/v1/ai/generate-monitor-spec

Monitor aus Beschreibung generieren

Verwendet KI zur Umwandlung natürlichsprachlicher Beschreibungen in strukturierte Monitor-Spezifikationen. Enthält Sicherheitsanalyse, Parameterextraktion und geschätztes Alarmvolumen. Hilft nicht-technischen Benutzern, komplexe Monitore zu erstellen.

Auth erforderlich

KI-Services

Direkter Zugriff auf KI-Fähigkeiten einschließlich Textanalyse, Entitätsextraktion, Beziehungsmapping und natürlicher Sprachverarbeitung.

POST
/api/v1/ai/analyze-text

Text mit KI analysieren

Führt umfassende KI-Analyse von Textinhalten durch. Extrahiert Entitäten, Beziehungen, Ereignisse, Stimmung und Schlüsselthemen. Unterstützt mehrere Sprachen mit automatischer Erkennung.

Auth erforderlich
POST
/api/v1/ai/generate-graph

Graph aus Text generieren

Erstellt einen Wissensgraphen aus unstrukturiertem Text. Identifiziert Entitäten, leitet Beziehungen ab und generiert strukturierte Graphdaten, die für Visualisierung oder Neo4j-Import geeignet sind.

Auth erforderlich
POST
/api/v1/ai/summarize

Inhalt zusammenfassen

Generiert prägnante Zusammenfassungen von Langform-Inhalten. Unterstützt mehrere Zusammenfassungslängen und -stile (Exekutiv, Technisch, Stichpunkte). Bewahrt Schlüsselentitäten und Fakten.

Auth erforderlich
POST
/api/v1/ai/extract-entities

Benannte Entitäten extrahieren

Extrahiert und klassifiziert benannte Entitäten aus Text. Gibt Entitätsspannen, Typen, Konfidenzwerte und aufgelöste Identifikatoren zurück, sofern verfügbar. Unterstützt benutzerdefinierte Entitätstypen.

Auth erforderlich

Dateiverwaltung

Hochladen, Herunterladen und Verwalten von Dateien mit vollständiger RBAC-Durchsetzung und Audit-Protokollierung.

POST
/api/v1/files

Datei hochladen

Lädt eine Datei in sicheren Speicher hoch. Erkennt automatisch den Dateityp und stellt ihn zur entsprechenden Verarbeitung in die Warteschlange. Gibt Datei-ID und Verarbeitungsstatus zurück. Unterstützt chunked Uploads für große Dateien.

Auth erforderlich
GET
/api/v1/files/{file_id}/download

Datei herunterladen

Lädt eine Datei mit vollständiger RBAC-Durchsetzung und Audit-Logging herunter. Verifiziert, dass der Benutzer Zugriff auf die zugeordnete Ermittlung/Vorgang hat. Unterstützt Range-Requests für große Dateien. Gibt Datei mit entsprechenden Content-Type-Headern zurück.

Auth erforderlich
GET
/api/v1/files/{file_id}/presigned-url

Presigned-URL abrufen

Generiert eine zeitlich begrenzte Presigned-URL für direkten Dateizugriff vom Cloudflare R2-Speicher. URL läuft nach konfigurierbarer Dauer ab (Standard 1 Stunde). Nützlich zum Einbetten von Dateien in Berichte oder Teilen mit externen Tools.

Auth erforderlich
GET
/api/v1/admin/files/{file_id}/audit

Datei-Audit-Trail (Admin)

Gibt vollständigen Audit-Trail für eine spezifische Datei zurück, einschließlich aller Zugriffsereignisse, Downloads und Modifikationen. Nur Admin oder Superuser. Essentiell für Chain-of-Custody-Dokumentation.

Admin/Superuser

API-Metadaten & Dokumentation

Selbstbeschreibende API-Endpunkte für dynamische Integration und Dokumentation.

GET
/api/v1/docs/endpoints

API Endpoint Documentation

Gibt umfassende Dokumentation aller API-Endpunkte zurück, einschließlich Pfaden, Methoden, Parametern und Response-Schemas. Wird zur Generierung von Client-SDKs und Integrationsdokumentation verwendet.

Öffentlich
GET
/api/v1/metadata/domains

Domänen-Metadaten

Gibt Metadaten über alle verfügbaren Domänen (Entitätstypen) zurück, einschließlich deren Eigenschaften, Beziehungen und UI-Konfiguration. Essentiell für den Aufbau dynamischer UIs, die sich an Schema-Änderungen anpassen.

Öffentlich
GET
/api/v1/metadata/enums

Enum-Metadaten

Gibt alle in der API verwendeten Aufzählungstypen zurück, einschließlich Statuscodes, Prioritätsstufen, Klassifizierungsstufen und anderen kategorialen Werten. Wird zum Befüllen von Dropdown-Menüs verwendet.

Öffentlich
GET
/api/v1/metadata/providers

Provider-Metadaten

Gibt Metadaten über verfügbare OSINT- und Datenanbieter zurück, einschließlich Fähigkeiten, Rate-Limits und erforderlicher Zugangsdaten. Wird zur Konfiguration von Datenquellen präferenzen verwendet.

Öffentlich

Audit & Compliance

Kryptografische Audit-Trails mit Merkle-Tree-Verifizierung für manipulationssichere Protokollierung.

GET
/api/v1/audit/anchor/latest

Neuesten Merkle-Anchor abrufen

Gibt den neuesten Merkle-Tree-Root-Hash zurück, der das Audit-Log verankert. Wird für kryptografische Verifizierung der Log-Integrität verwendet. Anchor wird periodisch zur Unveränderlichkeit auf Blockchain veröffentlicht.

Öffentlich
GET
/api/v1/audit/anchor/proof/{entry_id}

Inclusion-Proof abrufen

Gibt einen Merkle-Inclusion-Proof für einen spezifischen Audit-Eintrag zurück. Proof kann unabhängig gegen den veröffentlichten Anchor verifiziert werden. Essentiell für forensische Chain-of-Custody-Anforderungen.

Öffentlich
POST
/api/v1/mission-plans

Generieren Missionsplan

KI-unterstützte Missionsplanung basierend auf Szenariobeschreibung, Zielprofilen, geografischen Einschränkungen und Bedrohungsbewertung. Gibt strukturierten Plan mit Ressourcenzuweisung, Zeitplan und Eventualitäten zurück.

Auth erforderlich
PUT
/api/v1/mission-plans/{plan_id}

Missionsplan verfeinern

Verfeinert iterativ einen bestehenden Missionsplan basierend auf neuen Einschränkungen oder Feedback. Pflegt Planverlauf zum Vergleich. Unterstützt partielle Updates spezifischer Planabschnitte.

Auth erforderlich

Evidence and audit

Evidence and custody state

File, evidence, and audit endpoints need to preserve the same custody and integrity context shown in the operator workflow.

GRAPHQL

GraphQL-API

Die primäre GraphQL-API (api.knogin.com/graphql) bietet 100+ Queries, 80+ Mutations und Echtzeit-Subscriptions mit dem Strawberry-GraphQL-Framework. GraphQL ermöglicht flexibles Datenabrufen, sodass Clients genau die benötigten Daten in einer einzigen Anfrage anfordern können.

Domain

Ermittlungen

Erstellen, verwalten und verfolgen Sie Ermittlungen mit vollständiger Lifecycle-Unterstützung einschließlich Teamzuweisung, Dateiverwaltung und Fortschrittsverfolgung.

Domain

Vorgänge

Vollständige Vorgangverwaltung mit Vorlagen, Workflows, Statusverfolgung, Profilverlinkung und Bulk-Operationen für effiziente Vorgangbearbeitung.

Domain

Aufgaben

Aufgabenverwaltung mit Zuweisungen, Checklisten, Abhängigkeiten und Fortschrittsverfolgung für strukturierte Ermittlungsworkflows.

Domain

Notizen & Anhänge

Ermittlungsnotizen mit Rich-Text, Threading und Dateianhängen. Vollständiges Chain-of-Custody-Tracking für beweisgradige Dateien.

Domain

Profile & Entitäten

Entitätsprofilmanagement für Personen, Organisationen und andere Entitäten mit OSINT-Anreicherung und Beziehungsmapping.

Domain

Alarme & Monitore

Echtzeit-Alarmsystem mit konfigurierbaren Monitoren, Schweregrad-Stufen und Entscheidungsworkflows für Bedrohungserkennung.

Domain

Graph-Analyse

Wissensgraph-Operationen einschließlich Pfadfindung, Zentralitätsanalyse, Community-Erkennung und Link-Vorhersage für Netzwerk-Intelligence.

Domain

Geospatial Intelligence

Standortbasierte Abfragen, Clustering, Heatmaps, Geofencing und Timeline-Analyse für geografische Intelligence-Operationen.

Domain

Dashboards & Visualisierung

Erstellen und verwalten Sie anpassbare Dashboards mit Panels, Diagrammen und Echtzeit-Metriken für operative Awareness.

Domain

Suche & Entdeckung

Globale Suche mit semantischen Fähigkeiten, erweiterten Filtern und gespeicherten Abfragen für schnelle Intelligence-Entdeckung.

Domain

Beweisverwaltung

Gerichtszulässiges Beweis-Tracking mit Chain of Custody, Integritätsverifizierung und Versiegelung für Gerichtsverfahren.

Domain

OSINT & Anreicherung

Open-Source-Intelligence-Abfragen über mehrere Provider für Personen-, Organisations-, Telefon-, E-Mail-, Social-Media-, Fahrzeug-, Domain-, IP- und Kryptowährungsdaten.

Domain

Teams & Benutzer

Teamverwaltung mit Mitgliederrollen, Berechtigungen und Hierarchien für kollaborative Ermittlungsoperationen.

Domain

Workflows & Automation

Automatisierte Workflows mit Triggern, Bedingungen und Aktionen für optimierte Ermittlungsprozesse.

Domain

KI-Services

KI-gestützte Textanalyse, Entitätsextraktion, Zusammenfassung, Übersetzung und Dokumentenverarbeitungsfähigkeiten.

Domain

Benachrichtigungen & Kommentare

Echtzeit-Benachrichtigungen mit Einstellungen, Threaded-Kommentare, Erwähnungen und Reaktionen für Teamzusammenarbeit.

Beispiel: Ermittlung mit Vorgängen abfragen

Workspace query

Pull investigation, case, and operator context in one request when the client needs a live workspace rather than a single object.

GraphQL Query
query InvestigationWorkspace($investigationId: ID!) {
  investigation(id: $investigationId) {
    id
    title
    status
    createdAt
    profiles {
      id
      name
      type
      riskScore
    }
  }
  cases(investigationId: $investigationId) {
    id
    title
    status
    priority
    assignedTo {
      id
      displayName
    }
  }
}

Beispiel: Alarm-Mutation erstellen

Alert mutation

Mutation responses should return the core alert object plus the linked entities needed by triage and escalation workflows.

GraphQL Mutation
mutation CreateAlert($input: CreateAlertInput!) {
  createAlert(input: $input) {
    id
    title
    severity
    confidence
    createdAt
    entities {
      id
      name
      type
    }
  }
}

GraphQL-Endpunkt

Primary graph endpoint

Use GraphQL when the client needs investigation state, linked entities, tasks, evidence, and dashboard context in one round trip.

https://api.knogin.com/graphql
AlarmeErmittlungenDashboardsCollaborationVerarbeitungBenachrichtigungen

WEBSOCKET

WebSocket & Echtzeit

Echtzeitkommunikation über WebSocket für Live-Updates, GraphQL-Subscriptions und Collaboration-Features.

WebSocket-Endpunkte

Realtime endpoints

GraphQL subscriptions and event streams are separate lanes. Use the one that matches whether the client needs object-level updates or broader event fanout.

WS
wss://api.knogin.com/graphql

GraphQL Subscriptions

WebSocket-Endpunkt für GraphQL-Subscriptions unter Verwendung des graphql-ws-Protokolls. Unterstützt alle Subscription-Operationen einschließlich Alarm-Streams, Ermittlungs-Updates und Echtzeit-Collaboration.

Auth erforderlich
WS
wss://api.knogin.com/ws

General Event Stream

WebSocket-Endpunkt für allgemeines Echtzeit-Event-Streaming einschließlich Ermittlungs-Updates, Systembenachrichtigungen und Benutzerpрäsenz. Unterstützt kanalbasierte Subscriptions.

Auth erforderlich

Antwortformate

Response envelopes and status handling

Keep success, error, and rate-limit patterns explicit so integrators do not have to reverse engineer operational behavior from a preview environment.

Erfolgsantwort
{
  "success": true,
  "data": { ... },
  "message": "Operation completed successfully",
  "request_id": "req_abc123"
}
Fehlerantwort
{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input parameters",
  "code": "ERR_VALIDATION_001",
  "details": {
    "field": "email",
    "reason": "Invalid email format"
  }
}

HTTP-Statuscodes

HTTP status map

Häufige Statuscodes, die von der API zurückgegeben werden.

200OK - Anfrage erfolgreich
201Created - Ressource erstellt
204No Content - Erfolg ohne Body
400Bad Request - Ungültige Parameter
401Unauthorized - Authentifizierung erforderlich
403Forbidden - Zugriff verweigert
404Not Found - Ressource nicht gefunden
422Unprocessable Entity - Validierungsfehler
429Too Many Requests - Rate-limitiert
500Interner Serverfehler

Rate-Limits

Rate and payload limits

API-Rate-Limits zur Gewährleistung fairer Nutzung und Systemstabilität.

Standard-Endpunkte

1000 Anfragen pro Minute

Authentifizierungsendpunkte

5 Anfragen pro Minute (Login, MFA-Verifizierung)

Batch-Operationen

100 Profile pro Batch-Anfrage, 10 für Anreicherung

Datei-Uploads

50MB maximale Dateigröße

KI-Verarbeitung

Unterliegt Token-Limits pro Organisations-Tier

Bereit zur Integration?

Beginnen Sie mit unseren SDKs oder kontaktieren Sie unser Integrationsteam für Unterstützung.