Home | Appendix

|  |  | URL Commands

URL commands are a type of item link that don't merely point to an existing file, they issue some special commands to DEVONthink. Though not as powerful as AppleScript, these commands can be used in special circumstances. Terminology The URLs are constructed from a single command and optional parameters, with the following format: x-devonthink://<command>?<parameter=value&parameter=value&...>
Note: The first parameter after the ID is always added after a question mark (?), additional ones after an ampersand (&), and any values must be percent-encoded.
Listed below are the commands and parameters available: Commands: createFormattedNote: Creates a formatted note. createHTML: Creates a new HTML document. createMarkdown: Creates a Markdown document. createPDF: Creates a PDF. createRTF: Creates a rich text document. createWebArchive: Creates a web archive. createBookmark: Creates a new bookmark.
Note: Use the `location` parameter set to a URL with the commands above to download the page in the specified format.
createGroup: Creates a group. createText: Creates a new plain text document. clip: Opens the Clip to DEVONthink panel. note: Opens the Take Note panel. search: Initiates a search in the open databases. Parameters: title: The title of the item to be created (string). comment: A Comment to be added (string). location: The URL linking to the content, e.g., the URL of the website for the bookmark (URL). tags: Tags to be added (comma separated strings). destination: The UUID of a group where the item shall be created (string). source: The HTML content for HTML documents (string, only used by `createHTML` and `createFormattedNotes`). text: The text content for text documents (string, used by `createText` and `createMarkdown`). width: The page width (integer, only used by `createPDF`). paginated: Paginate the created PDF (boolean, only used by `createPDF`). hide: Hide and deactivate application after executing the comment (boolean). noselector: Skip group selector (boolean). query: The query to search for (string, only used by `search`). reader: Post-process the page (integer, 0 = no post-processing, any other value = post-process). referrer: The URL that referred to the item (URL). selection: The selected text (string, only used by `createRTF`).
Example: x-devonthink://createRTF?title=New%20bookmark&location=http%3A%2F%2Fwww.devontechnologies.com&noselector=1
Note: These are not x-callback-urls. An x-callback-url is a specific type of URL scheme that returns a value to the calling application.