ReferenceHyperlinks
Hyperlinks operations
Hyperlink discovery, creation, and metadata management.
6 operations. Names, descriptions, and behavior flags come from the canonical contract.
Operations
hyperlinks.getRetrieve details of a specific hyperlink by its inline address.readhyperlinks.insertInsert new linked text at a target position.mutatestrackedhyperlinks.listList the hyperlinks of one story, with optional filtering by href, anchor, or display text. The body is listed by default; pass `in` with a footnote or endnote story to list that note.readhyperlinks.patchUpdate hyperlink metadata (destination, tooltip, target, rel) without changing display text.mutateshyperlinks.removeRemove a hyperlink. Mode 'unwrap' preserves display text; 'deleteText' removes the linked content entirely.mutateshyperlinks.wrapWrap an existing text range with a hyperlink. A range inside one pending tracked insertion is linked without authoring a revision: the insertion keeps its author and date and is split at the range boundaries. Ranges that cross a revision boundary or touch deleted, moved or several revisions are refused.mutates