SpeakNotes API 文件

SpeakNotes API 可將音訊、影片、YouTube 連結和文件轉換為逐字稿和結構化摘要。這是一個 REST API,具備 OpenAPI 3.1 規範、代理技能檔案以及供 AI 客戶端使用的 MCP 伺服器。

基礎 URL

每個 SpeakNotes API 請求都會透過 HTTPS 發送到單一主機。

https://api.speaknotes.io

身份驗證

每個端點都需要身份驗證。請將 SpeakNotes API 金鑰作為 Bearer Token 發送,或者如果你是從已登入的會話中呼叫,則發送 Firebase ID Token。未經身份驗證的請求將被拒絕。

Authorization: Bearer YOUR_API_KEY

設定,API 金鑰. 中建立和撤銷金鑰。任何已登入的用戶都可以查看該頁面;建立金鑰需要有效的 Pro 方案。

端點

上傳和 YouTube 任務以非同步方式執行:建立筆記,然後輪詢其狀態直到處理完成。

  • GET/v1Describe the API
  • GET/v1/healthCheck the API is up
  • GET/v1/notesList notes
  • POST/v1/notesCreate a note from text
  • GET/v1/notes/{id}Get a note
  • PATCH/v1/notes/{id}Update a note
  • DELETE/v1/notes/{id}Delete a note
  • GET/v1/notes/{id}/statusGet processing status
  • GET/v1/notes/{id}/transcriptGet a transcript
  • POST/v1/notes/{id}/questionsAsk a question about a note
  • GET/v1/foldersList folders
  • POST/v1/foldersCreate a folder
  • GET/v1/folders/{id}Get a folder
  • PATCH/v1/folders/{id}Rename a folder
  • DELETE/v1/folders/{id}Delete a folder
  • POST/v1/uploadsStart a media upload
  • POST/v1/uploads/{id}/completeFinish an upload and start processing
  • POST/v1/transcriptionsTranscribe audio from a URL
  • POST/v1/summariesSummarize text
  • POST/v1/youtube-summariesSummarize a YouTube video
  • GET/v1/usageGet credit balance and usage

MCP 伺服器

SpeakNotes 透過 Streamable HTTP 執行 Model Context Protocol 伺服器,因此 MCP 客戶端可以將轉錄和摘要作為工具呼叫。它使用與 REST API 相同的 Bearer API 金鑰。

https://api.speaknotes.io/mcp

開發者資源