SpeakNotesSpeakNotes
Zacznij teraz

Dokumentacja API SpeakNotes

API SpeakNotes zamienia pliki audio, wideo, linki z YouTube i dokumenty w transkrypcje oraz ustrukturyzowane podsumowania. Jest to REST API ze specyfikacją OpenAPI 3.1, plikiem umiejętności agenta oraz serwerem MCP dla klientów AI.

Bazowy adres URL

Każde żądanie do API SpeakNotes jest kierowane do jednego hosta przez HTTPS.

https://api.speaknotes.io

Uwierzytelnianie

Każdy punkt końcowy wymaga uwierzytelnienia. Wyślij klucz API SpeakNotes jako token bearer lub token Firebase ID, jeśli wywołujesz API z zalogowanej sesji. Nieuwierzytelnione żądania są odrzucane.

Authorization: Bearer YOUR_API_KEY

Twórz i unieważniaj klucze w Ustawienia, klucze API. Każdy zalogowany użytkownik może wyświetlić tę stronę; utworzenie klucza wymaga aktywnego planu Pro.

Punkty końcowe

Przesyłanie plików i zadania z YouTube działają asynchronicznie: utwórz notatkę, a następnie sprawdzaj jej status, aż przetwarzanie się zakończy.

  • 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

Serwer MCP

SpeakNotes uruchamia serwer Model Context Protocol przez Streamable HTTP, dzięki czemu klienci MCP mogą wywoływać transkrypcję i podsumowywanie jako narzędzia. Używa tego samego klucza API typu bearer co REST API.

https://api.speaknotes.io/mcp

Zasoby dla programistów