SpeakNotesSpeakNotes
Commencer

Documentation de l'API SpeakNotes

L'API SpeakNotes transforme les fichiers audio, vidéo, les liens YouTube et les documents en transcriptions et résumés structurés. Il s'agit d'une API REST avec une spécification OpenAPI 3.1, un fichier de compétence pour agent et un serveur MCP pour les clients IA.

URL de base

Chaque requête vers l'API SpeakNotes est envoyée à un hôte unique via HTTPS.

https://api.speaknotes.io

Authentification

Chaque point de terminaison nécessite une authentification. Envoyez une clé API SpeakNotes en tant que jeton bearer, ou un jeton d'identification Firebase si vous appelez depuis une session connectée. Les requêtes non authentifiées sont rejetées.

Authorization: Bearer YOUR_API_KEY

Créez et révoquez vos clés dans Paramètres, clés API. Tout utilisateur connecté peut voir la page ; la création d'une clé nécessite un forfait Pro actif.

Points de terminaison

Les téléchargements et les tâches YouTube s'exécutent de manière asynchrone : créez la note, puis interrogez son statut jusqu'à ce que le traitement soit terminé.

  • 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

Serveur MCP

SpeakNotes exécute un serveur Model Context Protocol via HTTP diffusable, permettant aux clients MCP d'appeler la transcription et le résumé en tant qu'outils. Il utilise la même clé API bearer que l'API REST.

https://api.speaknotes.io/mcp

Ressources pour les développeurs