Drafts Reference

URLs

Drafts implements URL actions based on the x-callback-url specification, and registers the drafts5: URL scheme. All actions below should be formatted as follows:

Note that the x-callback-url host is optional in all drafts5 URLs. It is supported for consistency with the specification, but functionally it is not required and drafts5://[actionName]... will have the same result as drafts5://x-callback-url/[actionName]...

All URLs should be proper valid URLs with URL encoded values in query arguments. With a few exceptions, all actions support x-callback-url x-success, x-error and x-cancel arguments where appropriate.

NOTE: Some URL scheme parameters and actions require a Pro subscription. PRO

Supported Actions

/create iOS macOS

Create a new draft with the content passed in the “text” argument. If an x-success url is provided, it will be called the uuid parameter indicating the UUID of the draft which was created.

/open iOS macOS

Open an existing draft based on the UUID argument.

/get iOS macOS

Return the current content of the draft specified by the UUID argument as an argument to the x-success URL provided.

/prepend iOS macOS

Prepend the passed text to the beginning of a draft identified by the UUID argument.

/append iOS macOS

Append the passed text to the end of a draft identified by the UUID argument.

/replaceRange iOS macOS

Replace content in an existing draft, based on a range.

/search iOS macOS

Open drafts directly to the draft search field.

/workspace iOS macOS

Open drafts directly the draft list with a named workspace selected.

/loadActionGroup iOS macOS

Load an action group in the action list side panel.

/loadKeyboardActionGroup iOS macOS

Load an action group in the extended keyboard row.

/runAction iOS macOS

Run a drafts action on the passed text without saving that text to a draft.

/dictate iOS macOS

Open Drafts dictation interface. Pass the resulting dictated text to the x-success URL instead of saving it in Drafts.

/arrange iOS macOS

Open Drafts arrange interface. Pass the resulting arranged text to the x-success URL instead of saving it in Drafts.