SpeakNotesSpeakNotes
Começar

Documentação da API do SpeakNotes

A API do SpeakNotes transforma áudio, vídeo, links do YouTube e documentos em transcrições e resumos estruturados. É uma API REST com especificação OpenAPI 3.1, um arquivo de skill para agentes e um servidor MCP para clientes de IA.

URL base

Cada solicitação da API do SpeakNotes vai para um único host via HTTPS.

https://api.speaknotes.io

Autenticação

Cada endpoint requer autenticação. Envie uma chave de API do SpeakNotes como um token bearer, ou um token de ID do Firebase se você estiver chamando de uma sessão autenticada. Solicitações não autenticadas são rejeitadas.

Authorization: Bearer YOUR_API_KEY

Crie e revogue chaves em Configurações, chaves de API. Qualquer usuário autenticado pode visualizar a página; a criação de uma chave requer um plano Pro ativo.

Endpoints

Uploads e tarefas do YouTube são executados de forma assíncrona: crie a nota e, em seguida, verifique seu status até que o processamento seja concluído.

  • 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

Servidor MCP

O SpeakNotes executa um servidor do Protocolo de Contexto de Modelo (MCP) via HTTP transmissível, para que clientes MCP possam chamar transcrição e resumo como ferramentas. Ele usa a mesma chave de API bearer da API REST.

https://api.speaknotes.io/mcp

Recursos para desenvolvedores