Obsidian
Взаимодействие с вашим хранилищем Obsidian через Local REST API
Obsidian — это мощная база знаний и приложение для ведения заметок, работающее поверх локальной папки с обычными текстовыми файлами Markdown. Благодаря таким функциям, как двунаправленные ссылки, графовые представления и богатая экосистема плагинов, Obsidian широко используется для управления личными знаниями, исследований и документации.
С помощью интеграции AACFlow с Obsidian вы можете:
- Читать и создавать заметки: Получать содержимое заметок из вашего хранилища или создавать новые заметки программно в рамках автоматизированных рабочих процессов.
- Обновлять и редактировать заметки: Изменять существующие заметки полностью или редактировать содержимое в определенных местах внутри заметки.
- Искать в вашем хранилище: Находить заметки по ключевым словам или содержимому во всем вашем хранилище Obsidian.
- Управлять периодическими заметками: Получать доступ и создавать ежедневные или другие периодические заметки для ведения журнала и отслеживания задач.
- Выполнять команды: Запускать команды Obsidian удаленно для автоматизации операций с хранилищем.
Как это работает в AACFlow:
Добавьте блок Obsidian в ваш рабочий процесс и выберите операцию. Для этой интеграции требуется установленный и запущенный плагин Obsidian Local REST API в вашем хранилище. Укажите ваш API-ключ и URL хранилища вместе с любыми необходимыми параметрами. Блок взаимодействует с вашим локальным экземпляром Obsidian и возвращает структурированные данные, которые можно передать последующим блокам — например, поиск исследовательских заметок в вашем хранилище и передача их в AI-агент для суммирования.
Читайте, создавайте, обновляйте, ищите и удаляйте заметки в вашем хранилище Obsidian. Управляйте периодическими заметками, выполняйте команды и редактируйте содержимое в определенных местах. Требуется плагин Obsidian Local REST API.
Добавить содержимое в текущий активный файл в Obsidian
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
content | string | Да | Содержимое Markdown для добавления в активный файл |
| Параметр | Тип | Описание |
|---|
appended | boolean | Было ли содержимое успешно добавлено |
Добавить содержимое в существующую заметку в вашем хранилище Obsidian
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
filename | string | Да | Путь к заметке относительно корня хранилища (например, "folder/note.md") |
content | string | Да | Содержимое Markdown для добавления в заметку |
| Параметр | Тип | Описание |
|---|
filename | string | Путь к заметке |
appended | boolean | Было ли содержимое успешно добавлено |
Добавить содержимое в текущую периодическую заметку (ежедневную, еженедельную, ежемесячную, квартальную или годовую). Создает заметку, если она не существует.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
period | string | Да | Тип периода: daily, weekly, monthly, quarterly или yearly |
content | string | Да | Содержимое Markdown для добавления в периодическую заметку |
| Параметр | Тип | Описание |
|---|
period | string | Тип периода заметки |
appended | boolean | Было ли содержимое успешно добавлено |
Создать или заменить заметку в вашем хранилище Obsidian
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
filename | string | Да | Путь для заметки относительно корня хранилища (например, "folder/note.md") |
content | string | Да | Содержимое Markdown для заметки |
| Параметр | Тип | Описание |
|---|
filename | string | Путь созданной заметки |
created | boolean | Была ли заметка успешно создана |
Удалить заметку из вашего хранилища Obsidian
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
filename | string | Да | Путь к заметке для удаления относительно корня хранилища |
| Параметр | Тип | Описание |
|---|
filename | string | Путь удаленной заметки |
deleted | boolean | Была ли заметка успешно удалена |
Выполнить команду в Obsidian (например, открыть ежедневную заметку, переключить боковую панель)
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
commandId | string | Да | ID команды для выполнения (используйте операцию List Commands для обнаружения доступных команд) |
| Параметр | Тип | Описание |
|---|
commandId | string | ID выполненной команды |
executed | boolean | Была ли команда успешно выполнена |
Получить содержимое текущего активного файла в Obsidian
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
| Параметр | Тип | Описание |
|---|
content | string | Содержимое Markdown активного файла |
filename | string | Путь к активному файлу |
Получить содержимое заметки из вашего хранилища Obsidian
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
filename | string | Да | Путь к заметке относительно корня хранилища (например, "folder/note.md") |
| Параметр | Тип | Описание |
|---|
content | string | Содержимое Markdown заметки |
filename | string | Путь к заметке |
Получить текущую периодическую заметку (ежедневную, еженедельную, ежемесячную, квартальную или годовую)
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
period | string | Да | Тип периода: daily, weekly, monthly, quarterly или yearly |
| Параметр | Тип | Описание |
|---|
content | string | Содержимое Markdown периодической заметки |
period | string | Тип периода заметки |
Список всех доступных команд в Obsidian
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
| Параметр | Тип | Описание |
|---|
commands | json | Список доступных команд с ID и именами |
↳ id | string | Идентификатор команды |
↳ name | string | Человекочитаемое имя команды |
Список файлов и директорий в вашем хранилище Obsidian
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
path | string | Нет | Путь к директории относительно корня хранилища. Оставьте пустым для списка корня. |
| Параметр | Тип | Описание |
|---|
files | json | Список файлов и директорий |
↳ path | string | Путь к файлу или директории |
↳ type | string | Является ли запись файлом или директорией |
Открыть файл в интерфейсе Obsidian (создает файл, если он не существует)
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
filename | string | Да | Путь к файлу относительно корня хранилища |
newLeaf | boolean | Нет | Открывать ли файл в новой вкладке/листе |
| Параметр | Тип | Описание |
|---|
filename | string | Путь открытого файла |
opened | boolean | Был ли файл успешно открыт |
Вставить или заменить содержимое в определенном заголовке, ссылке на блок или поле frontmatter в активном файле
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
content | string | Да | Содержимое для вставки в целевое местоположение |
operation | string | Да | Как вставлять содержимое: append, prepend или replace |
targetType | string | Да | Тип цели: heading, block или frontmatter |
target | string | Да | Идентификатор цели (текст заголовка, ID ссылки на блок или имя поля frontmatter) |
targetDelimiter | string | Нет | Разделитель для вложенных заголовков (по умолчанию: "::") |
trimTargetWhitespace | boolean | Нет | Обрезать ли пробелы из цели перед сопоставлением (по умолчанию: false) |
| Параметр | Тип | Описание |
|---|
patched | boolean | Был ли активный файл успешно отредактирован |
Вставить или заменить содержимое в определенном заголовке, ссылке на блок или поле frontmatter в заметке
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
filename | string | Да | Путь к заметке относительно корня хранилища (например, "folder/note.md") |
content | string | Да | Содержимое для вставки в целевое местоположение |
operation | string | Да | Как вставлять содержимое: append, prepend или replace |
targetType | string | Да | Тип цели: heading, block или frontmatter |
target | string | Да | Идентификатор цели (текст заголовка, ID ссылки на блок или имя поля frontmatter) |
targetDelimiter | string | Нет | Разделитель для вложенных заголовков (по умолчанию: "::") |
trimTargetWhitespace | boolean | Нет | Обрезать ли пробелы из цели перед сопоставлением (по умолчанию: false) |
| Параметр | Тип | Описание |
|---|
filename | string | Путь отредактированной заметки |
patched | boolean | Была ли заметка успешно отредактирована |
Искать текст по заметкам в вашем хранилище Obsidian
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | API-ключ из настроек плагина Obsidian Local REST API |
baseUrl | string | Да | Базовый URL для Obsidian Local REST API |
query | string | Да | Текст для поиска по заметкам хранилища |
contextLength | number | Нет | Количество символов контекста вокруг каждого совпадения (по умолчанию: 100) |
| Параметр | Тип | Описание |
|---|
results | json | Результаты поиска с именами файлов, оценками и контекстами совпадений |
↳ filename | string | Путь к соответствующей заметке |
↳ score | number | Оценка релевантности |
↳ matches | json | Контексты совпадающего текста |
↳ context | string | Текст вокруг совпадения |
