Overview
The node integrates with the Readwise Reader API to list documents stored in a user's Readwise Reader account. It allows fetching documents filtered by various criteria such as category, location, tags, update time, and pagination cursor. This is useful for workflows that need to retrieve and process reading materials like articles, emails, PDFs, tweets, videos, and more from Readwise Reader.
Practical examples include:
- Automatically syncing newly added or updated documents into another system.
- Filtering documents by specific tags or categories for targeted processing.
- Paginating through large document collections to export or analyze them incrementally.
Properties
| Name | Meaning |
|---|---|
| Additional Options | A collection of optional filters and parameters to refine the document listing: |
| - Category | The document's category. Possible values: Article, Email, EPUB, Highlight, Note, PDF, RSS, Tweet, Video. |
| - Document ID | The unique identifier of a single document. If provided, the node returns only this document if found. |
| - Location | The document's location within Readwise Reader. Possible values: Archive, Feed, Later, New, Shortlist. |
| - Page Cursor | A string token from a previous request used to fetch the next page of documents when results span multiple pages. |
| - Tag | One or more tag keys (up to 5, comma-separated) to filter documents that have all specified tags. |
| - Updated After | ISO 8601 date-time string to fetch only documents updated after this timestamp. |
| - With HTML Content | Boolean flag indicating whether to include the full HTML content of each document. Enabling this may increase request processing time. |
Output
The node outputs JSON data representing the list of documents retrieved from the Readwise Reader API. Each item in the output corresponds to a document object containing metadata fields such as ID, title, category, location, tags, update timestamps, and optionally the full HTML content if requested.
If the node supports binary data output (not indicated here), it would typically represent attachments or document content in binary form, but this node focuses on JSON document metadata.
Dependencies
- Requires an API key credential for authenticating with the Readwise Reader API.
- The node makes HTTP requests to
https://readwise.io/api/v3. - No additional external dependencies are indicated.
Troubleshooting
Common issues:
- Invalid or missing API authentication token will cause authorization errors.
- Providing an invalid document ID or tag filter may result in empty responses.
- Pagination tokens (
pageCursor) must be used correctly; otherwise, subsequent pages cannot be fetched. - Requesting HTML content increases response size and processing time; consider disabling if performance is critical.
Error messages:
- Authorization errors usually indicate problems with the API key setup.
- Validation errors may occur if input parameters do not conform to expected formats (e.g., date format, tag syntax).
- Network or API downtime can cause request failures; retry or check service status.