Reader Add Tags To Document
reader_add_tags_to_documentFull Description
Add tags to a Reader document
Parameters (2 required)
document_idstringThe ID of the document to add tags to
tag_namesarrayThe tag names to add to the document
The official app for Readwise and Reader.
This app allows you to have chatgpt semantically search through all of your highlights, and any content saved to your Reader library.
More than that, it can do basically anything you can do in Reader! Triage your inbox, organize your library, catch up on your feed, and much more -- just ask :)
reader_add_tags_to_documentAdd tags to a Reader document
document_idstringThe ID of the document to add tags to
tag_namesarrayThe tag names to add to the document
reader_add_tags_to_highlightAdd tags to a Reader document highlight
document_idstringThe ID of the document containing the highlight
highlight_document_idstringThe ID of the highlight document to add tags to
tag_namesarrayThe tag names to add to the document
reader_bulk_edit_document_metadataEdit metadata fields for one or more Reader documents in a single call. Max 50 documents per call. Bulk update calls are rate-limited to 20 per minute (shared with reader_move_documents) — batch documents into fewer calls instead of calling once per document. Check the result success flags to confirm all documents have been edited successfully.
documentsarrayList of documents to edit, each with a document_id and the metadata fields to update
reader_create_documentSave a new document to Reader
authorstringThe document's author, overwrites the original author
nullcategorystringThe document category. Default is guessed based on the URL, usually article.
nullhtmlstringThe content of the document in HTML format. Use `markdown` instead if you have Markdown content. If not provided, Reader will try to scrape the URL.
nullimage_urlstringAn image URL to use as cover image
nullmarkdownstringThe content of the document in Markdown format. Use `html` instead if you have HTML content.
nullnotesstringA top-level note for the document
nullpublished_datestringWhen the document was published in ISO 8601 format
nullsummarystringSummary of the document
nulltagsarrayA list of tags to apply to the document
nulltitlestringThe document's title, overwrites the original title. Should be provided when `html` is provided.
nullurlstringThe unique URL of the document. If you don't have one, you can provide a made up value such as https://yourapp.com#document1
nullreader_create_highlightCreate a new highlight on a document by specifying the exact text to highlight
document_idstringThe ID of the document to highlight
html_contentstringThe exact HTML fragment to highlight. Must match a part of the HTML document exactly. The full HTML can be obtained from the reader_list_documents tool (html_content).
notestringOptional note to attach to the highlight
nulltagsarrayOptional tag names to apply to the highlight
nullreader_export_documentsExport all Reader documents as a ZIP file containing Markdown files with YAML frontmatter. This tool triggers the export and returns immediately with an export_id. Use reader_get_export_documents_status to poll for completion and get the download URL. The response includes last_updated which can be saved and passed as since_updated in a future export to only include documents updated since this export.
since_updatedstringOptional timestamp for delta exports. Only documents updated after this timestamp will be included. Use `last_updated` from a previous export.
nullreader_get_document_detailsGet Reader document details, including Markdown content
document_idstringThe ID of the document to get details for
reader_get_document_highlightsGet highlights for a Reader document
document_idstringThe ID of the document to get highlights for
reader_get_export_documents_statusCheck the status of a previously triggered Reader document export. Returns status ('processing' or 'completed'), progress counts, and a download_url when the export is complete.
export_idstringThe export ID returned by `reader_export_documents`.
reader_list_documentsList Reader documents. Documents are returned from the most recently added to the least recently added. This tool can be used to find N newest documents. Tip: unseen documents have first_opened_at=null, seen documents have a non-null first_opened_at. You can mark documents as seen with reader_bulk_edit_document_metadata(documents=[{document_id: ..., seen: true}]).
categorystringFilter by document category
nullidstringThe document's unique ID. Using this parameter will return just one document, if found.
nulllimitintegerThe maximum number of documents to return
10locationstringFilter by document location. 'new' = inbox (where newly saved documents go), 'later' = saved for later, 'shortlist' = shortlisted, 'archive' = archived, 'feed' = RSS feed items (only use when user explicitly asks about feed/RSS). When user says 'inbox', use 'new'.
nullpage_cursorstringA string returned by a previous request to get the next page of documents
nullresponse_fieldsarrayOptional fields to include in each document result. Use this to reduce response size and save tokens. The 'id' field is always included. If not specified, all fields are included.
nullseenbooleanFilter by seen status. True = only documents that have been opened, False = only unopened documents.
nulltagarrayFilter by tag(s). Pass up to 5 tags to find documents having all the tags listed. Pass empty string in the list to find untagged documents.
nullupdated_afterstringFetch only documents updated after this date (ISO 8601 datetime)
nullreader_list_tagsList Reader tags
reader_move_documentsMove one or more Reader documents to a different location (e.g. archive, later, shortlist). Max 50 documents per call. Bulk update calls are rate-limited to 20 per minute (shared with reader_bulk_edit_document_metadata) — batch document IDs into fewer calls instead of calling once per document. Check the result success flags to confirm all documents have been moved successfully.
document_idsarrayThe IDs of the documents to move
locationstringThe new location for the documents
newlatershortlistarchivefeedreader_remove_tags_from_documentRemove tags from a Reader document
document_idstringThe ID of the document to remove tags from
tag_namesarrayThe tag names to remove from the document
reader_remove_tags_from_highlightRemove tags from a Reader document highlight
document_idstringThe ID of the document containing the highlight
highlight_document_idstringThe ID of the highlight document to remove tags from
tag_namesarrayThe tag names to remove from the document
reader_search_documentsSearch Reader documents using hybrid search
querystringSearch in document content
author_searchstringSearch document author
nullcategory_inarrayRestrict search to specific categories
nulldocument_idstringRestrict search to a specific document
nulllimitintegerThe maximum number of documents to return
20location_inarrayRestrict search to specific locations. Values: 'new' (inbox), 'later', 'shortlist', 'archive'. When user says 'inbox', use ['new']. This tool does not search the feed, only locations in the user's library.Defaults to ["new", "later", "shortlist", "archive"].
nullnote_searchstringSearch in document notes
nullpublished_datestringSearch by published date (ISO 8601 date)
nullpublished_date_gtstringSearch by published date greater than (ISO 8601 date)
nullpublished_date_gtestringSearch by published date greater than or equal to (ISO 8601 date)
nullpublished_date_ltstringSearch by published date less than (ISO 8601 date)
nullpublished_date_ltestringSearch by published date less than or equal to (ISO 8601 date)
nullsource_searchstringSearch in document source
nullsummary_searchstringSearch in document summary
nulltags_inarrayRestrict search to specific tags
nulltags_searchstringSearch in document tags
nulltitle_searchstringSearch in document title
nullurl_searchstringSearch in document URL
nullreader_set_highlight_notesSet notes for a Reader document highlight
document_idstringThe ID of the document containing the highlight
highlight_document_idstringThe ID of the highlight document to set notes for
notesstringThe notes to set for the highlight. Pass null to clear the notes.
nullreadwise_create_highlightsCreate one or more highlights in Readwise. When creating a Reader document highlight, use reader_create_highlight instead. Each highlight can be from the same or multiple books/articles. If you don't include a title, we'll put the highlight in a generic 'Quotes' book. If you don't include an author we'll keep it blank or just use the URL domain (if a source_url was provided). We de-dupe highlights by title/author/text/source_url. We'll put the created highlights in a book, based on the title/author/source_url combination.
highlightsarrayList of highlights to create
readwise_delete_highlightDelete a Readwise highlight
highlight_idintegerThe ID of the highlight to delete
readwise_get_daily_reviewGet the user's daily review of highlights. Returns today's review with all highlights selected for review by the spaced repetition algorithm. Includes the review URL where the user can complete the review interactively.
readwise_list_highlightsList Readwise highlights with optional filters. Highlights are returned from the most recently added to the least recently added. This tool can be used to find N newest highlights.
book_idintegerFilter by book ID
nullhighlighted_at_gtstringFilter highlights created after this datetime (ISO 8601)
nullhighlighted_at_ltstringFilter highlights created before this datetime (ISO 8601)
nullpageintegerPage number for pagination
nullpage_sizeintegerNumber of highlights per page
100updated_gtstringFilter highlights updated after this datetime (ISO 8601)
nullupdated_ltstringFilter highlights updated before this datetime (ISO 8601)
nullreadwise_search_highlightsSearch Readwise highlights
vector_search_termstringSearches document content using vector search
full_text_queriesarrayOptional field targeted full text search queries
nulllimitintegerThe maximum number of highlights to return
30readwise_update_highlightUpdate a Readwise highlight. Supports adding and removing tags in a single call.
highlight_idintegerThe ID of the highlight to update
add_tagsarrayTag names to add to the highlight
nullcolorstringNew color for the highlight
nulllocationintegerNew location for the highlight
nullnotestringNew note for the highlight
nullremove_tagsarrayTag names to remove from the highlight (matched by name)
nulltextstringNew text for the highlight
nullurlstringNew URL for the highlight
null