diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).html index 693bdb39b..3d922c880 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).html @@ -1,11 +1,13 @@ +

ETAPI is Trilium's public/external REST API. It is available since Trilium v0.50.

-

The documentation is in OpenAPI format, available here.

API clients

As an alternative to calling the API directly, there are client libraries to simplify this

Obtaining a token

@@ -23,10 +25,10 @@ Authorization: ETAPITOKEN

Since v0.56 you can also use basic auth format:

GET https://myserver.com/etapi/app-info
 Authorization: Basic BATOKEN

Basic Auth is meant to be used with tools which support only basic auth.

Interaction using Bash scripts

@@ -42,10 +44,10 @@ NOTE_ID="i6ra4ZshJhgN" curl "$SERVER/etapi/notes/$NOTE_ID/content" -H "Authorization: $TOKEN"

Make sure to replace the values of:

As another example, to obtain a .zip export of a note and place it in a directory called out, simply replace the last statement in diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index c7f357caa..d748d499a 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -12568,6 +12568,13 @@ "value": "bx bx-extension", "isInheritable": false, "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "9qPsTWBorUhQ", + "isInheritable": false, + "position": 40 } ], "format": "markdown", diff --git a/docs/User Guide/User Guide/Advanced Usage/ETAPI (REST API).md b/docs/User Guide/User Guide/Advanced Usage/ETAPI (REST API).md index 12c284055..c50694b73 100644 --- a/docs/User Guide/User Guide/Advanced Usage/ETAPI (REST API).md +++ b/docs/User Guide/User Guide/Advanced Usage/ETAPI (REST API).md @@ -1,7 +1,8 @@ # ETAPI (REST API) -ETAPI is Trilium's public/external REST API. It is available since Trilium v0.50. +> [!TIP] +> For a quick start, consult theĀ API Reference. -The documentation is in OpenAPI format, available [here](https://github.com/TriliumNext/Trilium/blob/master/src/etapi/etapi.openapi.yaml). +ETAPI is Trilium's public/external REST API. It is available since Trilium v0.50. ## API clients