SpeakNotesSpeakNotes
Mulai

Dokumentasi API SpeakNotes

API SpeakNotes mengubah audio, video, tautan YouTube, dan dokumen menjadi transkrip dan ringkasan terstruktur. Ini adalah REST API dengan spesifikasi OpenAPI 3.1, file keterampilan agen, dan server MCP untuk klien AI.

URL Dasar

Setiap permintaan API SpeakNotes ditujukan ke satu host melalui HTTPS.

https://api.speaknotes.io

Otentikasi

Setiap endpoint memerlukan otentikasi. Kirim kunci API SpeakNotes sebagai token pembawa (bearer token), atau token ID Firebase jika Anda memanggil dari sesi yang sudah masuk. Permintaan yang tidak terotentikasi akan ditolak.

Authorization: Bearer YOUR_API_KEY

Buat dan cabut kunci di Pengaturan, kunci API. Setiap pengguna yang masuk dapat melihat halaman tersebut; membuat kunci memerlukan paket Pro aktif.

Endpoint

Unggahan dan pekerjaan YouTube berjalan secara asinkron: buat catatan, lalu polling statusnya hingga pemrosesan selesai.

  • 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

Server MCP

SpeakNotes menjalankan server Model Context Protocol melalui HTTP yang dapat dialirkan, sehingga klien MCP dapat memanggil transkripsi dan ringkasan sebagai alat. Server ini menggunakan kunci API bearer yang sama dengan REST API.

https://api.speaknotes.io/mcp

Sumber daya pengembang