Documentación de la API de SpeakNotes

La API de SpeakNotes convierte audio, video, enlaces de YouTube y documentos en transcripciones y resúmenes estructurados. Es una API REST con una especificación OpenAPI 3.1, un archivo de habilidades para agentes y un servidor MCP para clientes de IA.

URL base

Cada solicitud a la API de SpeakNotes se dirige a un único host a través de HTTPS.

https://api.speaknotes.io

Autenticación

Cada endpoint requiere autenticación. Envía una clave de API de SpeakNotes como token de portador (bearer token), o un token de ID de Firebase si estás llamando desde una sesión iniciada. Las solicitudes no autenticadas son rechazadas.

Authorization: Bearer YOUR_API_KEY

Crea y revoca claves en Configuración, claves de API. Cualquier usuario con sesión iniciada puede ver la página; crear una clave requiere un plan Pro activo.

Endpoints

Las cargas y los trabajos de YouTube se ejecutan de forma asíncrona: crea la nota y luego consulta su estado hasta que finalice el procesamiento.

  • 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

SpeakNotes ejecuta un servidor de Protocolo de Contexto de Modelo (MCP) sobre HTTP transmitible, para que los clientes MCP puedan llamar a la transcripción y el resumen como herramientas. Utiliza la misma clave de API de portador que la API REST.

https://api.speaknotes.io/mcp

Recursos para desarrolladores