وثائق SpeakNotes API

تحول SpeakNotes API الصوت والفيديو وروابط YouTube والمستندات إلى نصوص وملخصات منظمة. إنها REST API مع مواصفات OpenAPI 3.1، وملف مهارات الوكيل، وخادم MCP لعملاء الذكاء الاصطناعي.

عنوان URL الأساسي

كل طلب SpeakNotes API يذهب إلى مضيف واحد عبر HTTPS.

https://api.speaknotes.io

المصادقة

كل نقطة نهاية تتطلب مصادقة. أرسل مفتاح SpeakNotes API كرمز حامل (bearer token)، أو رمز Firebase ID إذا كنت تتصل من جلسة مسجل دخولها. يتم رفض الطلبات غير المصادق عليها.

Authorization: Bearer YOUR_API_KEY

قم بإنشاء وإلغاء المفاتيح في الإعدادات، مفاتيح API. يمكن لأي مستخدم مسجل الدخول عرض الصفحة؛ يتطلب إنشاء مفتاح اشتراك Pro نشط.

نقاط النهاية (Endpoints)

تعمل عمليات الرفع ومهام 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 بتشغيل خادم Model Context Protocol عبر Streamable HTTP، بحيث يمكن لعملاء MCP استدعاء وظائف النسخ والتلخيص كأدوات. يستخدم نفس مفتاح API (Bearer) الخاص بـ REST API.

https://api.speaknotes.io/mcp

موارد المطورين