SpeakNotesSpeakNotes
Начать работу

Документация SpeakNotes API

SpeakNotes API превращает аудио, видео, ссылки на YouTube и документы в транскрипты и структурированные резюме. Это REST API со спецификацией OpenAPI 3.1, файлом навыков агента и MCP-сервером для AI-клиентов.

Базовый URL

Каждый запрос к SpeakNotes API направляется на один хост по протоколу HTTPS.

https://api.speaknotes.io

Аутентификация

Каждый эндпоинт требует аутентификации. Отправьте API-ключ SpeakNotes в качестве токена bearer или Firebase ID-токен, если вы вызываете API из сессии авторизованного пользователя. Неавторизованные запросы отклоняются.

Authorization: Bearer YOUR_API_KEY

Создавайте и отзывайте ключи в Настройках, API-ключи. Любой авторизованный пользователь может просматривать эту страницу; для создания ключа требуется активный тариф Pro.

Эндпоинты

Загрузки и задачи YouTube выполняются асинхронно: создайте заметку, а затем опрашивайте её статус, пока обработка не завершится.

  • 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-сервер

SpeakNotes запускает сервер Model Context Protocol через Streamable HTTP, поэтому MCP-клиенты могут вызывать транскрибацию и суммаризацию в качестве инструментов. Используется тот же bearer API-ключ, что и для REST API.

https://api.speaknotes.io/mcp

Ресурсы для разработчиков