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é.

  • POST/youtube-checkValider une URL YouTube et vérifier les limites de durée
  • POST/youtube-summaryCréer une note à partir de YouTube et démarrer le résumé
  • POST/upload-urlCréer une note et obtenir une URL de téléchargement média signée
  • POST/upload-completeConfirmer le téléchargement média et démarrer le traitement
  • POST/pdf-upload-urlCréer une note et obtenir une URL de téléchargement de document signée
  • POST/pdf-upload-completeConfirmer le téléchargement du document et démarrer le traitement
  • GET/api/v1/notesLister vos notes
  • GET/api/v1/notes/{id}Récupérer une note unique
  • GET/api/v1/notes/{id}/statusInterroger le statut de traitement d'une note
  • GET/api/v1/foldersLister vos dossiers
  • GET/api/v1/folders/{id}Récupérer un dossier unique

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