2025-04-18 01:28:32 +03:00
|
|
|
|
# Script API
|
2025-04-13 19:09:14 +03:00
|
|
|
|
For [script code notes](../Scripting.md), Trilium offers an API that gives them access to various features of the application.
|
2025-03-10 21:15:33 +02:00
|
|
|
|
|
2025-04-13 19:09:14 +03:00
|
|
|
|
There are two APIs:
|
2025-03-10 21:15:33 +02:00
|
|
|
|
|
2025-04-13 19:09:14 +03:00
|
|
|
|
* One for the front-end scripts: <a class="reference-link" href="Script%20API/Frontend%20API">Frontend API</a>
|
|
|
|
|
|
* One for the back-end scripts: <a class="reference-link" href="Script%20API/Backend%20API.dat">Backend API</a>
|
|
|
|
|
|
|
|
|
|
|
|
In both cases, the API resides in a global variable, `api`, that can be used anywhere in the script.
|
|
|
|
|
|
|
|
|
|
|
|
For example, to display a message to the user the following front-end script can be used:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
api.showMessage("Hello world.");
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
> [!NOTE]
|
|
|
|
|
|
> **Note**
|
|
|
|
|
|
> The Script API is currently experimental and may undergo changes in future updates.
|
