API-Referenz

Serge Scanner-API

Die API stellt Serges deterministischen Scanner für programmatische Scans und Bericht-Abrufe bereit. Sie deckt nur das Scannen ab; das vollständige Agent-Journey-Test-Produkt lebt in der Haupt-App. Scans erfordern Authentifizierung — mit einem Secret Key sind 60 Scans/Stunde pro Workspace möglich. Das Lesen gecachter Berichte bleibt öffentlich.

OpenAPI-Spezifikationllms.txtVollständige Docs (llms-full.txt)MCP-SchnellstartMethodik
Ebenfalls verfügbar

Suchen Sie das lokale Claude-Desktop-Paket statt der gehosteten Scanner-API? Das Serge-MCP-Paket ist wieder in den Docs, einschließlich des Offline-Schnellstarts.

→ Serge-MCP-Schnellstart öffnen

Basis-URL

Authentifizierung

Das Starten von Scans erfordert Authentifizierung — anonyme Anfragen erhalten 401. Geben Sie einen geheimen Schlüssel über den Authorization-Header weiter:

Erstellen Sie geheime Schlüssel in Ihren Kontoeinstellungen. Schlüssel verwenden das Präfix sk_serge_. Behandeln Sie sie wie Passwörter.

Rate-Limits

Alle API-Antworten enthalten Rate-Limit-Header:

HeaderBeschreibung
X-RateLimit-LimitMaximale Anfragen pro Fenster
X-RateLimit-RemainingVerbleibende Anfragen
X-RateLimit-ResetUnix-Zeitstempel, wann das Fenster zurückgesetzt wird
Retry-AfterSekunden bis zum Reset (nur 429-Antworten)
TierRate-LimitAuth
AnonymNicht verfügbar — antwortet mit 401Keine
Authentifiziert60 Scans/h pro WorkspaceAuthorization: Bearer sk_serge_...

Domain-Rate-Limit: 5 Scans pro Stunde pro Ziel-Domain (über Tiers hinweg geteilt).

Endpunkte

POST/api/scan

Initiiert einen Domain-Scan. Gibt einen Server-Sent-Events-Stream mit Echtzeit-Fortschritt zurück, während der Scan die Site crawlt und Befunde ausgibt.

Request-Body
SSE-Events
statusScan-Phasen-Update — enthält die aktuelle Phasenbeschreibung
crawlCrawl-Fortschritt — enthält die gecrawlte URL und den Status
layerLayer-Scan abgeschlossen — enthält Layer-Nummer, Score und Prüfergebnisse
completeScan beendet — enthält Scan-ID, Gesamtscore und Aufschlüsselung pro Layer
errorScan fehlgeschlagen — enthält Fehlermeldung
Beispiel (anonym)
Beispiel (authentifiziert — 60 Scans/h)
GET/api/scan/{id}

Ruft die vollständigen Ergebnisse für einen abgeschlossenen Scan ab. Antworten werden 1 Stunde lang zwischengespeichert.

Pfadparameter
idUUID des Scans (zurückgegeben vom complete-SSE-Event)
Antwort
Fehlerantworten
400Ungültiges Scan-ID-Format
404Scan nicht gefunden
Beispiel

Webhook-Events

Serge kann Sie benachrichtigen, wenn sich der Score einer überwachten Domain ändert. Abonnieren Sie Score-Änderungsbenachrichtigungen über das E-Mail-Gate auf jeder Scan-Ergebnisseite.

score.changed

Maschinenlesbare Ressourcen

/openapi.jsonOpenAPI-3.1-Spezifikation
/llms.txtProduktbeschreibung für LLMs
/llms-full.txtErweiterte Dokumentation für LLMs
/.well-known/agent.jsonA2A-Agent-Karte mit Fähigkeiten
/.well-known/agent-visit-registry.jsonOptionales Agent-Besuchsregister (Daten, Endpunkt, Geltungsbereich)
/methodologyBewertungsmethodik (wird derzeit überarbeitet)
/sitemap.xmlXML-Sitemap
/robots.txtCrawler-Berechtigungen