La API
Un token, tres permisos y doce endpoints para que un atajo o un script pueda acceder a tus notas.
Con un token de API, un atajo del teléfono, un script o una app en otra computadora pueden acceder a tus notas sin iniciar sesión. Crea uno en Configuración → Tokens de API.
Permisos
| Permiso | Qué puede hacer |
|---|---|
capture |
Crear notas, con todo su texto. No puede leer ninguna |
read |
Listar, leer y buscar notas. No puede cambiar nada |
full |
Leer, buscar, crear, editar y organizar carpetas |
capture y read son independientes: ninguno incluye al otro. Un atajo
que manda ideas a una bandeja de entrada no tiene por qué leer todo lo que has
escrito, así que un token capture en un teléfono perdido no expone nada.
Autenticación
Envía el token como credencial bearer:
curl -H "Authorization: Bearer scr_..." https://app.scratchpad.sh/api/notes
Endpoints
Solo estos aceptan un token, ninguno más. Por eso un token nunca puede crear ni revocar otro token, ni hacer cambios en tu cuenta.
| Método | Ruta | Permiso | Qué hace |
|---|---|---|---|
GET |
/api/notes |
read |
El resumen de todas las notas, más las carpetas |
POST |
/api/notes |
capture |
Crea una nota; text o markdown, y folderId, todos opcionales |
GET |
/api/notes/:id |
read |
Una nota, con el JSON de su documento |
GET |
/api/notes/:id/export?format=md |
read |
Una nota en Markdown, texto sin formato o JSON |
PATCH |
/api/notes/:id |
full |
Edita: doc o markdown, más title, folderId, pinned |
POST |
/api/notes/:id/append |
full |
Agrega al final sin tocar lo que ya hay |
GET |
/api/search?q= |
read |
Búsqueda de texto completo en tus notas |
GET |
/api/notes/:id/attachments |
read |
Los archivos de una nota y el texto de cada uno: ?file= con ?q= para buscar en él, o ?from= y ?to= para un rango de páginas |
GET |
/api/folders |
read |
Todas las carpetas, con parent_id en las que están dentro de otra |
POST |
/api/folders |
full |
Crea una: name, y parentId para ponerla dentro de otra |
PATCH |
/api/folders |
full |
Cambia el nombre con id y name, o mueve con parentId y order: todas las carpetas que deben quedar dentro de parentId, en orden |
DELETE |
/api/folders |
full |
Elimina: id. Con un token, solo carpetas vacías |
Para mover una nota a una carpeta, usa PATCH /api/notes/:id con folderId, o
con null para sacarla de su carpeta.
Con un token solo puedes eliminar una carpeta vacía. Si todavía tiene notas o
subcarpetas, recibes un 409 que te dice qué hay dentro. Desde la app no
existe este límite, porque te pide confirmación y además se puede deshacer.
Texto o Markdown
Siempre que envíes contenido, puedes usar text o markdown, pero no ambos.
text es texto sin formato: un párrafo por línea, y una línea que empieza con
# sigue empezando con #. Es lo ideal para un atajo o una regla de correo, que
solo capturan palabras sin darles formato.
markdown se interpreta, así que los encabezados, las listas, las listas de
tareas, las tablas y los bloques de código llegan como tales. Es lo ideal para
un asistente. Lo que el editor no admite se convierte en texto, en lugar de
rechazarse.
Para leer pasa lo mismo, al revés. GET /api/notes/:id devuelve el JSON del
documento, que es exacto, pero tienes que entender su estructura.
GET /api/notes/:id/export devuelve Markdown, y es la mejor opción para leer
el texto.
Agregar al final
Usa POST /api/notes/:id/append en lugar de leer la nota, agregarle una línea
y mandarla completa de vuelta con PATCH. Si alguien escribe en la app entre tu
lectura y tu escritura, esa escritura lo borraría. Append agrega a la nota tal
como está en ese momento.
curl -X POST https://app.scratchpad.sh/api/notes/NOTE_ID/append \
-H "Authorization: Bearer scr_..." \
-H "Content-Type: application/json" \
-d '{"markdown": "- [ ] ring the dentist"}'
Si la nota está completamente vacía, el contenido la reemplaza en lugar de agregarse, así la primera línea sigue convirtiéndose en el título. Una nota con texto conserva cada línea en blanco exactamente donde la dejaste.
Última actualización: 21 de septiembre de 2026