Skip to main content
Readwise Reader logo
  • Category: bookmark managers
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 7
  • Triggers: 0
  • Slug: READWISE_READER
  • Version: 20261103_00

Tools

Slug: READWISE_READER_BULK_UPDATE_DOCUMENTSPartially update up to 50 Reader documents in one request and return a success or error result for every document.

Input Parameters

array
required
One to 50 independent partial updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: READWISE_READER_CREATE_HIGHLIGHTSCreate or update one or more highlights in the connected Readwise library and return the affected sources and modified highlight IDs.

Input Parameters

array
required
One or more highlights to create or update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: READWISE_READER_DELETE_DOCUMENTPermanently delete one Reader document by its ID. Deleting a document also deletes its highlights and their notes; deleting a highlight also deletes its note.

Input Parameters

string
required
Reader document ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: READWISE_READER_LIST_DOCUMENTSList, filter, incrementally sync, or fetch a specific Reader document. Returns one page and a cursor for the next page.

Input Parameters

array
Require all supplied tag names, up to five. Use a list containing one empty string to find untagged documents.
integer
Maximum documents to return in this page (1-100).
string ("article" | "email" | "rss" | "highlight" | "note" | "pdf" | "epub" | "tweet" | "video")
Filter by document category.
string ("new" | "later" | "shortlist" | "archive" | "feed")
Filter by Reader location.
string
Return only the document with this Reader ID; no match returns an empty results array.
string
Cursor returned as next_cursor by a previous call; omit for the first page and pass it back unchanged.
string
Return documents updated after this ISO 8601 datetime for incremental synchronization.
boolean
Include html_content in each result; this can increase processing time and response size.
boolean
Include a direct source URL valid for one hour when distribution is allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: READWISE_READER_LIST_TAGSList tags in the connected Reader library, returning one page and a cursor for the next page.

Input Parameters

string
Cursor returned as next_cursor by a previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: READWISE_READER_SAVE_DOCUMENTSave a document in the connected Reader library using a required URL and optional supplied HTML, metadata, location, and tags. Returns the Reader document ID needed by update and delete tools.

Input Parameters

string
required
Unique source URL. Use a stable synthetic URL when the document has no real URL; Reader scrapes it when html is omitted.
string
Valid HTML content to save instead of asking Reader to scrape the URL.
array
Tag names to assign to the saved document.
string
Top-level note to store on the document.
string
Title override for the saved document.
string
Author override for the saved document.
string
Summary to store on the document.
string ("article" | "email" | "rss" | "highlight" | "note" | "pdf" | "epub" | "tweet" | "video")
Document category; Reader usually infers article when omitted.
string
Language code such as en, de, or en-US; Reader auto-detects it when omitted.
string ("new" | "later" | "archive" | "feed")
Initial Reader location.
string
Cover image URL.
string
Name of the source or integration that saved the document.
string
ISO 8601 publication datetime; Reader assumes UTC when no timezone is supplied.
boolean
Whether Reader should clean supplied HTML and derive title and author metadata. Only use with html. When false, title and author are required; omit this field to use Reader’s default behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: READWISE_READER_UPDATE_DOCUMENTPartially update supported fields on one Reader document by ID; omitted fields remain unchanged. For highlights, only notes and tags can be updated; notes cannot be updated directly.

Input Parameters

boolean
True marks the document seen and records open times; false clears those times.
array
Complete replacement list of tag names.
string
Replacement top-level document note; an empty string clears it. This field cannot add notes to highlight documents.
string
Replacement title.
string
Replacement author.
string
Replacement summary.
string ("article" | "email" | "rss" | "highlight" | "note" | "pdf" | "epub" | "tweet" | "video")
Replacement document category.
string
Replacement language code such as en, de, or en-US.
string ("new" | "later" | "archive" | "feed")
Move the document to this Reader location.
string
Replacement cover image URL.
string
required
Reader document ID to update.
string
Replacement publication datetime; Reader assumes UTC when no timezone is supplied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not