# x-callback-url endpoints

UpNote supports several x-callback-url endpoints you can use to automate certain tasks from other application:

#### View a note:

upnote://x-callback-url/openNote?noteId=\[noteId]\&new\_window=\[true|false]

#### Create a note:

upnote://x-callback-url/note/new?title=\[title]\&text=\[text]\&notebook=\[notebook]\&new\_window=\[true|false]\&markdown=\[true|false]

#### View notes in a notebook:

upnote://x-callback-url/openNotebook?notebookId=\[notebookId]

#### Create a notebook:

upnote://x-callback-url/notebook/new?title=\[title]

#### View notes in a tag:

upnote://x-callback-url/tag/view?tag=\[title]

#### View notes in a filter:

upnote://x-callback-url/openFilter?filterId=\[filterId]

#### **View dynamically:**

upnote://x-callback-url/view?

Supported query parameters: `mode`, `noteId`, `notebookId`, `tagId`, `filterId`, `spaceId`, `action`, `query`.

`mode`:

* `all_notes`: View notes in All Notes.
* `quick_access`: View notes in Quick Access.
* `templates`: View all templates.
* `trash`: View notes in Trash.
* `notebooks`: View notes in a notebook. You need to provide `notebookId` in the search parameters.
* `tags`: View notes in a tag. You need to provide `tagId` in the search parameters.
* `filters`: View notes in a filter. You need to provide `filterId` in the search parameters.
* `all_notebooks`: View all notebooks.
* `all_tags`: View all tags.

`noteId`: If `noteId` is provided, UpNote will open to this note in the editor.

`spaceId`: The unique id of the space, or `default` for the default space. If `spaceId` is not provided in the parameters, UpNote will open the link in the current space.

`action`: If the action is `search`, you can pass extra parameter `query` so that UpNote will perform searching with the query provided.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.getupnote.com/resources/x-callback-url-endpoints.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
