SpeakNotes API दस्तावेज़

SpeakNotes API ऑडियो, वीडियो, YouTube लिंक और दस्तावेज़ों को ट्रांसक्रिप्ट और संरचित सारांश में बदल देता है। यह एक REST API है जिसमें OpenAPI 3.1 स्पेक, एक एजेंट स्किल फ़ाइल, और AI क्लाइंट के लिए एक MCP सर्वर है।

बेस URL

हर SpeakNotes API अनुरोध HTTPS पर एक सिंगल होस्ट पर जाता है।

https://api.speaknotes.io

प्रमाणीकरण

हर एंडपॉइंट के लिए प्रमाणीकरण आवश्यक है। यदि आप साइन-इन सत्र से कॉल कर रहे हैं, तो एक SpeakNotes API कुंजी को बेयरर टोकन के रूप में, या 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 पर एक मॉडल कॉन्टेक्स्ट प्रोटोकॉल सर्वर चलाता है, ताकि MCP क्लाइंट ट्रांसक्रिप्शन और सारांश को टूल के रूप में कॉल कर सकें। यह REST API के समान बेयरर API कुंजी का उपयोग करता है।

https://api.speaknotes.io/mcp

डेवलपर संसाधन