API pública

Resumen

Screvi ofrece una API REST pública para leer tus subrayados y fuentes de forma programática. Úsala para crear flujos de trabajo personalizados, exportar datos a otras herramientas o desarrollar tus propias integraciones.

Autenticación

Todas las solicitudes a la API requieren una clave API incluida en el encabezado X-API-Key.

Obtener tu clave API

1. Ve a Configuración > API en la aplicación web de Screvi
2. Copia tu clave API

Usar la clave

Incluye la clave en cada solicitud:

GET https://api.screvi.com/api/v1/highlights
X-API-Key: your-api-key-here

Límites de tasa

• 100 solicitudes por minuto por clave API
• Los encabezados de límite de tasa se incluyen en las respuestas

Puntos finales disponibles

Subrayados

GET /api/v1/highlights

Obtén tus subrayados con paginación y filtros.

Parámetros de consulta:

• page: Número de página (por defecto: 1)
• limit: Resultados por página
• source_id: Filtrar por fuente
• favorite: Filtrar por favoritos (true/false)
• updated_since: Devuelve solo subrayados actualizados después de esta fecha

Fuentes

GET /api/v1/sources

Obtén tus fuentes (libros, artículos, etc.) con paginación.

Documentación de la API

La documentación completa e interactiva está disponible en:

https://api.screvi.com/api/docs

Esta interfaz Swagger te permite explorar todos los puntos finales, ver esquemas de solicitud/respuesta e intentar solicitudes directamente.

Casos de uso de ejemplo

• Exportar subrayados a una base de datos personalizada en Notion
• Crear un flujo de trabajo personalizado en Obsidian o usar el plugin oficial de Screvi para sincronizar tu bóveda
• Crear un panel personalizado con estadísticas de lectura
• Automatizar flujos de trabajo para publicar subrayados en X/Twitter
• Alimentar subrayados a la base de conocimientos de un asistente de IA