SpeakNotes API 文档

SpeakNotes API 将音频、视频、YouTube 链接和文档转换为转录稿和结构化摘要。这是一个带有 OpenAPI 3.1 规范、智能体技能文件和用于 AI 客户端的 MCP 服务器的 REST API。

基础 URL

每个 SpeakNotes API 请求都通过 HTTPS 发送到单个主机。

https://api.speaknotes.io

身份验证

每个端点都需要身份验证。发送 SpeakNotes API 密钥作为承载令牌(bearer token),或者如果您从已登录的会话中调用,则发送 Firebase ID 令牌。未经身份验证的请求将被拒绝。

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 通过流式 HTTP 运行 Model Context Protocol 服务器,因此 MCP 客户端可以将转录和摘要作为工具调用。它使用与 REST API 相同的 bearer API 密钥。

https://api.speaknotes.io/mcp

开发者资源