Home

Appendix

Application Icon   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:

  • Icon
    createFormattedNote: Creates a formatted note.
  • Icon
    createHTML: Creates a new HTML document.
  • Icon
    createMarkdown: Creates a Markdown document.
  • Icon
    createPDF: Creates a PDF.
  • Icon
    createRTF: Creates a rich text document.
  • Icon
    createWebArchive: Creates a web archive.
  • Icon
    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.

  • Icon
    createGroup: Creates a group.
  • Icon
    createText: Creates a new plain text document.
  • Icon
    clip: Opens the Clip to DEVONthink panel.
  • Icon
    note: Opens the Take Note panel.
  • Icon
    search: Initiates a search in the open databases.

Parameters:

  • Icon
    title: The title of the item to be created (string).
  • Icon
    comment: A Comment to be added (string).
  • Icon
    location: The URL linking to the content, e.g., the URL of the website for the bookmark (URL).
  • Icon
    tags: Tags to be added (comma separated strings).
  • Icon
    destination: The UUID of a group where the item shall be created (string).
  • Icon
    source: The HTML content for HTML documents (string, only used by createHTML and createFormattedNotes).
  • Icon
    text: The text content for text documents (string, used by createText and createMarkdown).
  • Icon
    width: The page width (integer, only used by createPDF).
  • Icon
    paginated: Paginate the created PDF (boolean, only used by createPDF).
  • Icon
    hide: Hide and deactivate application after executing the comment (boolean).
  • Icon
    noselector: Skip group selector (boolean).
  • Icon
    query: The query to search for (string, only used by search).
  • Icon
    reader: Post-process the page (integer, 0 = no post-processing, any other value = post-process).
  • Icon
    referrer: The URL that referred to the item (URL).
  • Icon
    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.