Skip to content

Latest commit

 

History

History
182 lines (113 loc) · 4.55 KB

README.md

File metadata and controls

182 lines (113 loc) · 4.55 KB
Raw


Obsidian REST

Self-hostable API for quick Obsidian captures
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Acknowledgments

About The Project

This project was developped as an API middleware to quickly capture notes or audio-notes to a self-hosted REST API for later upload and organisation on Obsidian.

It grew out of frustration with the mobile Obsidian app that makes quick capture mostly impossible in case of inspiration burst

(back to top)

Getting Started

With Docker

Running this command will start the service on port 8888 (replace with the one you want)

  docker run -d -p 8888:8000 -v /your/persistent/directory:/obsidian-rest/var --name obsidian-rest ghcr.io/benbaja/obsidian-rest:latest

Make sure to map the X folder to a persistent space in your disk to keep the database alive

Setup

  1. Connect to your Obsidian-REST instance and create an admin password
  2. Generate your API token
  3. (Optional) Create a Swiftink account, and enter your Swiftink API token
  4. Download the quickAdd script and add it to your Obsidian vault
  5. In Obsidian, install quickAdd
  6. Create a new quickAdd macro named Obsidian-REST, add the downloaded script as the only step
  7. In the script settings, add the Obsidian-REST endpoint URL and the token
  8. Create a quickAdd capture choice, and use {{MACRO:Obsidian-REST}} as the capture format

(back to top)

Usage

POST /capture/create

Payload :

capture_type: note | audio

for text notes

todo: boolean (optional) formats the captured note as a to-do item

text: string text of the note to capture

for audio

audio: base64 base64 encoding of the audio file

file_name: string name of the audio file

Returns : new_note_id or new_audio_id

POST /capture/update

Payload :

captureIDs: string[] note IDs to mark as "fetched" on the database

Returns : captureIDs

GET /capture/

Returns for each capture :

text: string

date_added: date

todo: boolean

following: note_id (optional)

audio_id: audio_id (optional)

capture_id: note_id

GET /capture/<note_id>

Returns :

text: string

date_added: date

todo: boolean

following: note_id (optional)

audio_id: audio_id (optional)

capture_id: note_id

iOS Shortcut

An iOS shortcut can be downloaded here

(back to top)

Roadmap

  • Swagger API documentation
  • Browsable captures
    • Re-trigger speech-to-text in case of failure
  • Option for alternative speech-to-text (whisper)
  • CI/CD
  • Custom capture type and handling
    • Auto-generated quickAdd script for custom captures

See the open issues for a full list of proposed features (and known issues).

(back to top)

Acknowledgments

(back to top)