SpeakNotes API-Dokumentation

Die SpeakNotes API verwandelt Audio, Video, YouTube-Links und Dokumente in Transkripte und strukturierte Zusammenfassungen. Es handelt sich um eine REST-API mit einer OpenAPI 3.1-Spezifikation, einer Agent-Skill-Datei und einem MCP-Server für KI-Clients.

Basis-URL

Jede SpeakNotes API-Anfrage erfolgt über HTTPS an einen einzigen Host.

https://api.speaknotes.io

Authentifizierung

Jeder Endpunkt erfordert eine Authentifizierung. Senden Sie einen SpeakNotes API-Schlüssel als Bearer-Token oder ein Firebase-ID-Token, wenn Sie von einer angemeldeten Sitzung aus aufrufen. Nicht authentifizierte Anfragen werden abgelehnt.

Authorization: Bearer YOUR_API_KEY

Erstellen und widerrufen Sie Schlüssel unter Einstellungen, API-Schlüssel. Jeder angemeldete Benutzer kann die Seite einsehen; zum Erstellen eines Schlüssels ist ein aktiver Pro-Plan erforderlich.

Endpunkte

Uploads und YouTube-Aufträge werden asynchron ausgeführt: Erstellen Sie die Notiz und fragen Sie dann den Status ab, bis die Verarbeitung abgeschlossen ist.

  • POST/youtube-checkValidieren Sie eine YouTube-URL und prüfen Sie die Dauerbegrenzungen
  • POST/youtube-summaryErstellen Sie eine Notiz von YouTube und starten Sie die Zusammenfassung
  • POST/upload-urlErstellen Sie eine Notiz und erhalten Sie eine signierte Medien-Upload-URL
  • POST/upload-completeBestätigen Sie den Medien-Upload und starten Sie die Verarbeitung
  • POST/pdf-upload-urlErstellen Sie eine Notiz und erhalten Sie eine signierte Dokument-Upload-URL
  • POST/pdf-upload-completeBestätigen Sie den Dokument-Upload und starten Sie die Verarbeitung
  • GET/api/v1/notesListen Sie Ihre Notizen auf
  • GET/api/v1/notes/{id}Rufen Sie eine einzelne Notiz ab
  • GET/api/v1/notes/{id}/statusFragen Sie den Verarbeitungsstatus einer Notiz ab
  • GET/api/v1/foldersListen Sie Ihre Ordner auf
  • GET/api/v1/folders/{id}Rufen Sie einen einzelnen Ordner ab

MCP-Server

SpeakNotes betreibt einen Model Context Protocol-Server über Streamable HTTP, sodass MCP-Clients Transkription und Zusammenfassung als Tools aufrufen können. Er verwendet denselben Bearer-API-Schlüssel wie die REST-API.

https://api.speaknotes.io/mcp

Entwickler-Ressourcen