---
canonical_url: "https://docs.composio.dev/toolkits/readwise_reader"
markdown_url: "https://docs.composio.dev/toolkits/readwise_reader.md"
product: "platform"
version: null
last_updated: null
---

# Readwise Reader

Save, list, organize, update, and delete documents in a Readwise Reader library.

- **Category:** bookmark managers
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 6
- **Triggers:** 0
- **Slug:** `READWISE_READER`
- **Version:** 00000000_00

## Tools

### Bulk Update Documents

**Slug:** `READWISE_READER_BULK_UPDATE_DOCUMENTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `updates` | array | Yes | One to 50 independent partial updates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Document

**Slug:** `READWISE_READER_DELETE_DOCUMENT`

Permanently delete one Reader document by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | Reader document ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Documents

**Slug:** `READWISE_READER_LIST_DOCUMENTS`

List, filter, incrementally sync, or fetch a specific Reader document. Returns one page and a cursor for the next page.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `READWISE_READER_LIST_TAGS`

List tags in the connected Reader library, returning one page and a cursor for the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next_cursor` | string | No | Cursor returned as next_cursor by a previous call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save Document

**Slug:** `READWISE_READER_SAVE_DOCUMENT`

Save a URL or supplied HTML as a document in the connected Reader library, with optional metadata, location, and tags. Returns the Reader document ID needed by update and delete tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Unique source URL. Use a stable synthetic URL when the document has no real URL; Reader scrapes it when html is omitted. |
| `html` | string | No | Valid HTML content to save instead of asking Reader to scrape the URL. |
| `tags` | array | No | Tag names to assign to the saved document. |
| `notes` | string | No | Top-level note to store on the document. |
| `title` | string | No | Title override for the saved document. |
| `author` | string | No | Author override for the saved document. |
| `summary` | string | No | Summary to store on the document. |
| `category` | string ("article" | "email" | "rss" | "highlight" | "note" | "pdf" | "epub" | "tweet" | "video") | No | Document category; Reader usually infers article when omitted. |
| `language` | string | No | Language code such as en, de, or en-US; Reader auto-detects it when omitted. |
| `location` | string ("new" | "later" | "archive" | "feed") | No | Initial Reader location. |
| `image_url` | string | No | Cover image URL. |
| `saved_using` | string | No | Name of the source or integration that saved the document. |
| `published_date` | string | No | ISO 8601 publication datetime; Reader assumes UTC when no timezone is supplied. |
| `should_clean_html` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document

**Slug:** `READWISE_READER_UPDATE_DOCUMENT`

Partially update supported fields on one Reader document by ID; omitted fields remain unchanged.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |