10 ETAPI

zadam edited this page 2022-10-09 21:34:41 +02:00

Table of Contents

• Authentication

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

The documentation is in OpenAPI format, available here.

trilium-py is a third-party Python implementation for ETAPI client, you can use Python to communicate with Trilium.

Authentication

All operations have to be authenticated using a token. You can get this token either from Options -> ETAPI or programmatically using the /auth/login REST call (see the spec):

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

Alternatively, since 0.56 you can also use basic auth format:

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

• Where BATOKEN = BASE64(username + ':' + password) - this is a standard Basic Auth serialization
• Where username is "etapi"
• And password is the generated ETAPI token described above.

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

• Screenshot tour
• Basic concepts
  • Document
  • Note
    • Text notes
    • Links
    • Images
    • Attachments
    • Cloning notes
    • Protected notes
    • Archived notes
    • Note revisions
  • Navigation
    • Tree concepts
    • Tree manipulation
    • Note navigation
    • Search
    • Bookmarks
    • Note hoisting
    • Workspace
  • Keyboard shortcuts
  • Themes
    • Theme Gallery
  • Import & Export
    • Markdown
    • Evernote
    • Onenote
• Installation & setup
  • Server installation
    • Packaged server installation
    • Docker server installation
    • NixOS server installation
    • Manual server installation
    • Kubernetes server installation
    • Apache proxy setup
    • Nginx proxy setup
    • TLS configuration
  • Desktop installation
  • Synchronization
  • Mobile frontend
  • Web clipper
  • Upgrading Trilium
  • Backup
  • Data-Directory
• Advanced usage
  • Attributes
    • Attribute inheritance
    • Promoted attributes
    • Template
  • Relation map
  • Note map
  • Book note
  • Sharing
  • Code notes
    • Scripts
    • Script API
    • Custom request handler
    • Events
    • Custom Widget
  • Advanced showcases
    • Day notes
    • Weight Tracker
    • Task Manager
  • ETAPI (REST API)
  • Default note title
• Developer guides
  • Frontend Basics
  • Widget Basics
• FAQ
• Troubleshooting

Back to Overview