Use of ETAPI with curl

[maphew]

EDIT: To resolve this issue, #61 (comment) should be integrated into the documentation.

---

Trilium Version

0.63.5

What operating system are you using?

Other (specify below)

What is your setup?

Server access only

Operating System Version

Windows 10.0.19045 Build 19045

Description

Using ETAPI call to export a note and it's children results in {"message":"Router not found for request GET //notes/root/export"}.
Server is Synology NAS with zadam/Trilium running in a container. It works as expected interactively via browser.

Win10 Git Bash console session:

export TRILIUM_TOKEN=T83DaEf4*******************************64WRl8=
export TRILIUM_SERVER=http://nas:8080/

# indivudual branch:
curl -H "Authorization: Basic ${TRILIUM_TOKEN}" ${TRILIUM_SERVER}/notes/FlE3sCcgtRkW/export 
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    66  100    66    0     0    186      0 --:--:-- --:--:-- --:--:--   186{"message":"Router not found for request GET //notes/root/export"}

#everything:
curl -H "Authorization: Basic ${TRILIUM_TOKEN}" ${TRILIUM_SERVER}/notes/root/export`
**  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    66  100    66    0     0    186      0 --:--:-- --:--:-- --:--:--   186{"message":"Router not found for request GET //notes/root/export"}
**

Am I missing something in my command line?

Error logs

04:12:48.802 Slow 304 GET /api/sync/check with 10475 bytes took 32ms
04:12:59.696 200 GET /api/health-check with 15 bytes took 2ms
04:13:09.851 Error: Router not found for request POST /api/notes/FlE3sCcgtRkW/export
04:13:30.300 200 GET /api/health-check with 15 bytes took 2ms
04:13:33.701 Error: Router not found for request POST /etapi/notes/FlE3sCcgtRkW/export
04:13:40.698 304 GET /api/setup/status with 59 bytes took 2ms
04:13:40.731 200 POST /api/login/sync with 54 bytes took 3ms
...
20:49:26.253 200 GET /api/health-check with 15 bytes took 2ms
20:49:27.322 Error: Router not found for request GET //notes/root/export
20:49:42.843 304 GET /api/setup/status with 59 bytes took 2ms
20:49:42.853 200 POST /api/login/sync with 54 bytes took 3ms

[maphew]

route not found error is because of missing etapi prefix in the url path, so the url should be $server/etapi/notes/$noteId/export. However after correcting for that the error changes to "Not authorized", so something is wrong with the curl auth headers.

The BATOKEN is an attempt to use Basic authentication following the sparse zadam wiki ETAPI page.

#!/bin/bash

# Get note ID from first argument
noteid=$1

if [ -z "$noteid" ]; then
  echo "Usage: $0 <noteid>"
  exit 1
fi

export TRILIUM_SERVER=http://nas:8080
export TRILIUM_BATOKEN=$(echo -n "etapi:$TRILIUM_TOKEN" | base64)

curl -H "Authorization: Bearer $TRILIUM_TOKEN" \
  -X GET $TRILIUM_SERVER/etapi/notes/$noteid/export

curl -H "Authorization: Basic $TRILIUM_BATOKEN" \
  -X GET $TRILIUM_SERVER/etapi/notes/$noteid/export

$ ./sh-export.sh root
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    71  100    71    0     0   1925      0 --:--:-- --:--:-- --:--:--  2088{"status":401,"code":"NOT_AUTHENTICATED","message":"Not authenticated"}
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    71  100    71    0     0   2571      0 --:--:-- --:--:-- --:--:--  2840{"status":401,"code":"NOT_AUTHENTICATED","message":"Not authenticated"}

I know the token environment variable is correct because using trilium-py works:

import os
from trilium_py.client import ETAPI

server_url = "http://nas:8080/"
token = os.environ["TRILIUM_TOKEN"]

ea = ETAPI(server_url, token)
print(ea.app_info())

# export specified branch starting at node_id
# noteId = "FlE3sCcgtRkW" # a specific note
noteId = "root" # everything

res = ea.export_note(
    noteId=noteId,
    format="html",
    savePath=f"out/{noteId}.zip",
)

python -u "a:\code\mhw\metril\export-website.py"
{'appVersion': '0.63.5', 'dbVersion': 228, 'nodeVersion': 'v18.18.2', 'syncVersion': 32, 'buildDate': '2024-03-28T07:11:39+01:00', 'buildRevision': '399458b52f250b22be22d980a78de0b3390d7521', 'dataDirectory': '/home/node/trilium-data', 'clipperProtocolVersion': '1.0', 'utcDateTime': '2024-04-26T06:03:02.910Z'}
2024-04-30 06:09:42.953 | INFO     | trilium_py.client:export_note:522 - 200

[maphew]

Solved the curl error: Authorization header doesn't need to indicate kind unless it's Basic. Here's a fixed script:

#!/bin/bash
# Get note ID from first argument
noteid=$1
if [ -z "$noteid" ]; then
  echo "Usage: $0 <noteid>"
  exit 1
fi

# change to your Trilium server
export TRILIUM_SERVER=http://nas:8080

# Requires TRILIUM_TOKEN environment variable set
curl -H "Authorization: $TRILIUM_TOKEN" \
  -X GET $TRILIUM_SERVER/etapi/notes/$noteid/export \
  --output out/$noteid.zip

Leaving issue open until I figure out where to place a similar example in the docs.

[eliandoran]

@maphew , any update regarding this subject?

[maphew]

thanks for the bump @eliandoran, I'd forgotten I had left this one hanging.

I would add the curl snippet to the end of wherever ETAPI.md is now (was https://github.com/TriliumNext/Docs/blob/main/Wiki/etapi.md), and refactor a bit:

#!/bin/bash
# Set Trilium server URL and API token
export TRILIUM_SERVER="http://your-server-here:8080"
export TRILIUM_TOKEN="your-api-token-here"

# Get note ID from first argument
noteid=$1
if [ -z "$noteid" ]; then
  echo "Usage: $0 <noteid>"
  exit 1
fi

# Ensure output directory exists
mkdir -p out

# Fetch and save the note export
curl -H "Authorization: $TRILIUM_TOKEN" \
  -X GET "$TRILIUM_SERVER/etapi/notes/$noteid/export" \
  --output "out/$noteid.zip"