Tài liệu API SpeakNotes

API SpeakNotes biến âm thanh, video, liên kết YouTube và tài liệu thành các bản ghi chép và tóm tắt có cấu trúc. Đây là một REST API với thông số kỹ thuật OpenAPI 3.1, tệp kỹ năng tác nhân và máy chủ MCP cho các ứng dụng AI.

URL cơ sở

Mọi yêu cầu API SpeakNotes đều gửi đến một máy chủ duy nhất qua HTTPS.

https://api.speaknotes.io

Xác thực

Mọi điểm cuối (endpoint) đều yêu cầu xác thực. Gửi khóa API SpeakNotes dưới dạng bearer token hoặc mã thông báo Firebase ID nếu bạn đang gọi từ phiên đã đăng nhập. Các yêu cầu không xác thực sẽ bị từ chối.

Authorization: Bearer YOUR_API_KEY

Tạo và thu hồi khóa trong Cài đặt, khóa API. Bất kỳ người dùng đã đăng nhập nào cũng có thể xem trang này; việc tạo khóa yêu cầu gói Pro đang hoạt động.

Điểm cuối (Endpoints)

Các công việc tải lên và YouTube chạy không đồng bộ: tạo ghi chú, sau đó kiểm tra trạng thái của nó cho đến khi quá trình xử lý hoàn tất.

  • 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

Máy chủ MCP

SpeakNotes chạy máy chủ Model Context Protocol qua Streamable HTTP, vì vậy các ứng dụng khách MCP có thể gọi các công cụ chuyển đổi giọng nói thành văn bản và tóm tắt. Nó sử dụng cùng một khóa API bearer như REST API.

https://api.speaknotes.io/mcp

Tài nguyên dành cho nhà phát triển