Öffentliche API

Überblick

Screvi bietet eine öffentliche REST-API zum Abrufen deiner Highlights und Quellen über Code. Nutze sie, um benutzerdefinierte Workflows zu erstellen, Daten in andere Tools zu exportieren oder deine eigenen Integrationen zu bauen.

Authentifizierung

Alle API-Anfragen erfordern einen API-Schlüssel im X-API-Key-Header.

API-Schlüssel abrufen

1. Gehe zu Einstellungen > API in der Screvi Web-App
2. Kopiere deinen API-Schlüssel

Schlüssel verwenden

Füge den Schlüssel in jede Anfrage ein:

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

Rate Limits

• 100 Anfragen pro Minute pro API-Schlüssel
• Rate-Limit-Header sind in Antworten enthalten

Verfügbare Endpunkte

Highlights

GET /api/v1/highlights

Rufe deine Highlights mit Pagination und Filtern ab.

Abfrageparameter:

• page: Seitennummer (Standard: 1)
• limit: Ergebnisse pro Seite
• source_id: Nach Quelle filtern
• favorite: Nach Favoriten filtern (true/false)
• updated_since: Nur Highlights seit diesem Datum

Quellen

GET /api/v1/sources

Rufe deine Quellen (Bücher, Artikel etc.) mit Pagination ab.

API-Dokumentation

Die vollständige interaktive API-Dokumentation findest du hier:

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

Diese Swagger UI ermöglicht es dir, alle Endpunkte zu erkunden, Request- und Response-Schemas zu sehen und Anfragen direkt zu testen.

Anwendungsbeispiele

• Highlights in eine benutzerdefinierte Notion-Datenbank exportieren
• Einen benutzerdefinierten Obsidian-Workflow erstellen oder das offizielle Screvi Obsidian-Plugin für Vault-Synchronisierung verwenden
• Ein persönliches Dashboard mit Lesestatistiken erstellen
• Highlight-zu-Twitter/X-Posting-Workflows automatisieren
• Highlights in die Wissensbasis eines KI-Assistenten einspeisen