Zum Hauptinhalt springen

Authentifizierung und API-Schlüssel

Verfügbar inProResearch

Jeder Aufruf der REST-API trägt einen API-Schlüssel. Ein Schlüssel gehört zu deinem Konto, hat die Scopes, die du ihm gegeben hast, und zählt auf die Limits deines Tarifs. Diese Seite zeigt, wie du einen erstellst und nutzt. Die Liste der Scopes und die Limits pro Tarif stehen unter Schlüssel, Scopes und Limits.

Bevor du anfängst​

  • Ein Tarif Pro oder Research. Free-Konten können nur MCP-Schlüssel erstellen, die am MCP-Server funktionieren und nicht an der REST-API. Siehe Einen MCP-Client verbinden.

Einen Schlüssel erstellen​

  1. Öffne Einstellungen und wähle API und MCP.
  2. Drücke unter API-Schlüssel auf Schlüssel erstellen.
  3. Gib einen Name des Schlüssels ein, der dir sagt, wo der Schlüssel verwendet wird, zum Beispiel nightly-sync.
  4. Hake die Berechtigungen an, die der Schlüssel braucht, und nicht mehr. Schreib-Scopes lassen den Schlüssel deine Bibliothek ändern, gib sie also nur Skripten, denen du vertraust.
  5. Drücke Erstellen.
  6. Kopiere den Schlüssel jetzt. Er beginnt mit pk_, und Readsira zeigt ihn nur einmal an. Danach zeigt die Liste eine Kurzform wie pk_1a2b...9z8y.

Die Schlüsselliste zeigt, wann jeder Schlüssel zuletzt benutzt wurde. Ein Schlüssel, der nie benutzt wurde, zeigt Nie verwendet. Beim ersten Gebrauch eines Schlüssels fügt Readsira in der App einen Hinweis hinzu, der den Schlüssel nennt, sodass eine unerwartete Nutzung sichtbar wird.

Den Schlüssel mit einer Anfrage senden​

Sende den Schlüssel im Authorization-Header als Bearer-Token:

curl https://api.readsira.com/rest/v2/usage \
  -H "Authorization: Bearer $READSIRA_KEY"

Der X-API-Key-Header funktioniert ebenfalls:

curl https://api.readsira.com/rest/v2/usage \
  -H "X-API-Key: $READSIRA_KEY"

Ein Schlüssel in der Adresse (?api_key=pk_...) wird mit 401 und dem Code API_KEY_IN_QUERY abgelehnt, weil Adressen in Logs und im Browserverlauf landen.

Bewahre den Schlüssel in einer Umgebungsvariable oder einem Secret-Speicher auf. Lege ihn nicht in Code, der eingecheckt wird, nicht in eine Webseite und nicht in eine App, die du an andere weitergibst.

Prüfen, ob es funktioniert​

GET /rest/v2/usage antwortet für jeden Scope. Es zeigt deinen Tarif, die heutige Anzahl der Anfragen und die Limits dieses Schlüssels.

{
  "success": true,
  "data": {
    "plan": "pro",
    "requestsToday": 12,
    "requestsPerDay": 10000,
    "mcpCallsToday": 0,
    "mcpCallsPerDay": 10000,
    "requestsPerHour": 600,
    "askAnswersPerMonth": 300,
    "aiBudget": [{ "group": "chat", "percentUsed": 3 }]
  },
  "meta": {
    "timestamp": "2026-11-04T09:00:00.000Z",
    "path": "/rest/v2/usage",
    "method": "GET",
    "statusCode": 200
  }
}

Die Zahlen oben sind ein Beispiel; deine sind die Limits deines Tarifs. Wenn der Aufruf mit 401 antwortet, ist der Schlüssel falsch, widerrufen oder abgelaufen. Wenn er mit 402 PLAN_REQUIRED antwortet, ist das Konto im Free-Tarif. Siehe Ratenlimits und Fehler.

Welchen Scope eine Route braucht​

Eine Route lehnt einen Schlüssel ohne ihren Scope mit 403 SCOPE_REQUIRED ab. Die Referenz nennt den Scope unter jeder Route. Die am häufigsten genutzten:

ScopeDer Schlüssel darf
read:librarySuchen, Dokumente, Chunks und Transkripte lesen
ask:libraryFragen stellen, die mit Quellenangaben beantwortet werden (verbraucht dein KI-Budget)
read:projectsProjekte auflisten und ihren Kontext lesen
write:projectsQuellen und Notizen zu Projekten hinzufügen
write:uploadsAudio-, Video- und PDF-Dateien hochladen
read:bookmarks, write:bookmarksLesezeichen auf den Routen unter /api/v1/bookmarks lesen und schreiben
read:collectionsSammlungen auf den Routen unter /api/v1/collections lesen

Wenn du einen Schlüssel mit einem Scope erstellst, den dein Tarif nicht enthält, antwortet die API mit 400 SCOPE_NOT_ALLOWED.

Einen Schlüssel ersetzen oder entfernen​

Öffne in der Zeile des Schlüssels das Aktionsmenü.

  • Neu erzeugen gibt dem Schlüssel ein neues Geheimnis. Der Schlüssel behält seinen Namen, seine Scopes und seinen Verlauf, und das alte Geheimnis funktioniert sofort nicht mehr. Nutze es, wenn ein Schlüssel womöglich durchgesickert ist, und aktualisiere dann deine Skripte.
  • Widerrufen löscht den Schlüssel. Skripte, die ihn nutzen, funktionieren nicht mehr.

Die Liste Aktivität auf derselben Seite zeigt jeden Aufruf eines Schlüssels: die Zeit, die Route, den Status und die Anzahl der Ergebnisse. Sie speichert weder deinen Suchtext noch Dokumentinhalte.

Tipps​

  • Nutze einen Schlüssel pro Skript, damit du einen widerrufen kannst, ohne die anderen zu stören.
  • Gib einem reinen Lese-Job nur Lese-Scopes.
  • Behandle Text, der aus gespeicherten Seiten zurückkommt, als Daten, nie als Anweisungen an ein Modell.
Letztes Update am