Acessando anotações da ferramenta Obsidian utilizando API

O Obsidian é uma poderosa ferramenta de gerenciamento de notas e ideias baseada em markdown, utilizada por estudantes, profissionais e criadores de conteúdo.
É possível integra-lo com ferramenta de automações através de uma API, podendo ser tornar uma ferramenta muito útil.

Tópicos:

  • O Plugin
  • Como Configurar o Plugin Local REST API
  • Possibilidades com a API
  • Integrando no Google Sheets
  • Lendo uma anotação
  • Gravando uma anotação

O Plugin

Para isso, você pode utilizar o plugin “Local REST API”, disponível na seção “Plugins da Comunidade” do Obsidian.
Esse plugin habilita o acesso às anotações por meio de uma API REST, permitindo que você leia, edite e manipule suas notas de forma programática.

Como Configurar o Plugin Local REST API

  • Instalação do Plugin:
    • Acesse as configurações do Obsidian e habilite os “Plugins da Comunidade”.
    • Procure por “Local REST API” na loja de plugins e instale-o.
  • Configuração Local:
    • Após instalar, ative o plugin.
    • Habilite a opção “Enable non-encrypted HTTP server” para que o servidor local seja inicializado e permita acesso às anotações.
  • Configuração para Uso com Docker:
    • Se você deseja acessar a API do Obsidian localmente por meio de um contêiner Docker, altere a configuração de “Binding Host” para 0.0.0.0. Isso permitirá que o servidor esteja acessível em todas as interfaces de rede do host.

Possibilidades com a API

Com a API habilitada, você pode realizar diversas operações nas anotações, como:

  • Integrações com automações: Automatizar tarefas com ferramentas como Zapier ou n8n.
  • Sincronização: Criar fluxos de sincronização com outras plataformas de notas.
  • Análises: Extrair e processar dados armazenados nas notas para gerar relatórios ou insights.
  • Edições Programáticas: Alterar conteúdos de forma automática ou em massa.

Lendo uma anotação

Para ler uma anotação, você pode utilizar para testes a ferramenta Postman (https://www.postman.com/) para realizar as requisições confirmando o funcionamento da API.

Criei a anotação “minha-nota” no Obsidian e quero acessá-la via API, para isso irei preencher as seguintes informações no Postman.

URL: http://127.0.0.1:27123/vault/minha-nota.md

  • Caso seja outro nome ou esteja em uma pasta, altere o valor ‘minha-nota’ pelo caminho desejado
  • Em token preencha a informação de API Key mostrada no plugin do Local Rest API

Gravando uma anotação

Para gravar uma anotação, altere o tipo de requisição de GET para POST.
Informe no corpo (body), o conteúdo desejado para que seja gravado na anotação

Como no exemplo abaixo:

E por hoje é isso, até a próxima!