REST API

[saitatter]

Where can I find the rest api endpoints ?

[dosubot[bot]]

You can find Trilium's public REST API endpoints in the ETAPI documentation, which is provided in OpenAPI format here. For usage details and authentication, check the ETAPI wiki page: ETAPI documentation.

If you want to create custom REST endpoints, Trilium supports backend JavaScript notes labeled with #customRequestHandler, which expose endpoints under the /custom path. More info on custom handlers is in the Custom request handler wiki.

For developers, the main REST and ETAPI route definitions are in the codebase under apps/server/src/routes/api and apps/server/src/etapi.

To reply, just mention @dosu.

---

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

[saitatter]

@dosu that link doesn't work

[dosubot[bot]]

You're right, that link is outdated. The current OpenAPI specification for Trilium's ETAPI REST API is located in the repository at apps/server/src/assets/etapi.openapi.yaml, and when Trilium is running, you can access it at /etapi/etapi.openapi.yaml on your server (source). This spec lists all REST API endpoints, including /notes, /create-note, /branches, /attributes, /attachments, /auth/login, /auth/logout, and more.

If you want to see how endpoints are implemented, check the grouped files under apps/server/src/etapi/ (for example: notes.ts, branches.ts, attributes.ts, attachments.ts, auth.ts). User-facing documentation and usage samples are also available in the docs directory, but some references may still point to the old spec location (source).

To reply, just mention @dosu.

---

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