Otentikasi API SpeakNotes

Kunci API

Kirim kunci sebagai bearer token pada setiap permintaan. Akun apa pun yang sudah masuk dapat membuatnya, dan kunci tersebut langsung berfungsi.

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

Kunci live dimulai dengan sn_live_ dan beroperasi pada pustaka asli Anda. Kunci sandbox dimulai dengan sn_test_ dan berjalan terhadap output tetap. Kunci yang diterbitkan sebelum cakupan ada tetap berfungsi dan memiliki akses penuh.

Cakupan (Scopes)

Setiap kunci dan setiap token OAuth membawa cakupan. Membaca tidak pernah berarti menulis, jadi kunci dengan cakupan notes:read tidak dapat menghapus apa pun. Permintaan yang kehilangan cakupan akan mendapatkan respons 403 yang menyebutkan apa yang kurang.

• 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.

Batas kecepatan

Batas dihitung per kredensial, bukan per IP, sehingga satu integrasi tidak dapat menghabiskan kuota integrasi lainnya. Setiap respons membawa X-RateLimit-Limit, X-RateLimit-Remaining, dan X-RateLimit-Reset, dan 429 membawa 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

Membangun sesuatu yang digunakan pengguna SpeakNotes lain untuk masuk? Gunakan OAuth daripada meminta mereka menempelkan kunci. /developers/oauth