Trilium API Documentation?

[lordgpm]

Hi! I'm trying to learn how to code and I wanted to customize Trilium via widgets and scripts. However, the documentation stops at the basic widgets. The Frontend and Backend API documentations are 404ed and also not available in the repo guide.

Is it located elsewhere? I want to know what to call for some stuff so I can build my own widgets and whatnot. Thank you!

[dosubot[bot]]

Hi @lordgpm! I'm Dosu and I’m helping the Trilium team.

The official Trilium API docs for frontend and backend scripting are currently in flux—many old links are broken or 404. The most up-to-date API docs are in the repo under docs/Script API/modules/ as Frontend_Script_API.html and Backend_Script_API.html. You can view these by browsing the repo or building the docs locally. There's also an online version at https://triliumnext.github.io/Notes/Script%20API/, but some links there may still be broken or slow to load. The maintainers are aware of the situation and are reorganizing the docs, but you can ask for help navigating them if needed source.

For practical guides and examples, check out the in-repo docs like Custom Widgets.md and the Frontend Basics wiki. These explain how to create widgets and use the scripting API. The API is available as the global api variable in frontend scripts. For backend scripting, Trilium supports "custom request handlers"—backend JS notes labeled with #customRequestHandler that expose REST endpoints source.

If you want more examples or inspiration, the GitHub Discussions "show-and-tell" category and the awesome-trilium list have community-contributed widgets, scripts, and themes source.

Some features (like advanced UI elements or auto-complete fields) aren't exposed in the public API yet, and some widget examples in the docs may not work perfectly due to bugs or incomplete documentation source. For now, exploring the in-repo docs, code comments, and community resources is the best way to discover what's possible.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}    

[lordgpm]

Thank you! This is what I was looking for.

[eliandoran]

The up-to-date original documentation can actually be found at: http://docs.triliumnotes.org/
cc @dosu