SpeakNotes API-Authentifizierung

API-Schlüssel

Senden Sie den Schlüssel bei jeder Anfrage als Bearer-Token. Jeder angemeldete Account kann einen Schlüssel erstellen, der sofort einsatzbereit ist.

curl https://api.speaknotes.io/v1/notes \
  -H "Authorization: Bearer sn_live_YOUR_API_KEY"

Live-Schlüssel beginnen mit sn_live_ und wirken sich auf Ihre echte Bibliothek aus. Sandbox-Schlüssel beginnen mit sn_test_ und arbeiten mit festen Ausgabewerten. Schlüssel, die vor der Einführung von Scopes ausgestellt wurden, funktionieren weiterhin und verfügen über vollen Zugriff.

Scopes

Jeder Schlüssel und jedes OAuth-Token ist mit Scopes verknüpft. Lesen impliziert niemals Schreiben; ein Schlüssel mit dem Scope notes:read kann also nichts löschen. Eine Anfrage, der ein Scope fehlt, erhält einen 403-Fehler, der angibt, welcher Scope fehlt.

• notes:readRead notes, transcripts, and summaries.
• notes:writeCreate, update, and delete notes.
• folders:readRead folders.
• folders:writeCreate, update, and delete folders.
• transcriptions:writeTranscribe audio and video.
• summaries:writeGenerate summaries from audio, text, and YouTube URLs.
• usage:readRead credit balance and usage history.

Ratenbegrenzungen

Die Limits werden pro Anmeldedaten gezählt, nicht pro IP-Adresse, sodass eine Integration eine andere nicht blockieren kann. Jede Antwort enthält X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset, und ein 429-Fehler enthält Retry-After.

HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer realm="SpeakNotes API", error="invalid_token",
  resource_metadata="https://api.speaknotes.io/.well-known/oauth-protected-resource"

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_token",
    "message": "The API key is invalid, expired, or revoked.",
    "doc_url": "https://speaknotes.io/developers/errors#invalid_token"
  }
}

OAuth

Entwickeln Sie etwas, bei dem sich andere SpeakNotes-Nutzer anmelden sollen? Verwenden Sie OAuth, anstatt sie zu bitten, einen Schlüssel einzufügen. /developers/oauth