SpeakNotesSpeakNotes
Jetzt starten

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.

  • 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-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