変更履歴

Eagle Web API V2 の変更履歴です。すべての重要な変更を記録しています。

circle-info

V1 API の変更履歴をお探しですか?旧バージョン V1 API ドキュメントarrow-up-rightをご覧ください。


V2 API -- 初回リリース

V2 API(/api/v2/...)は、Eagle の Plugin API の機能に基づいて構築された V1 API の包括的な後継版です。主な機能:

新機能(V1 との比較)

  • 全文検索 -- POST /api/v2/item/query で高度なクエリ構文(AND、OR、NOT、フレーズ)に対応

  • AI セマンティック検索 -- テキスト説明による検索(searchByText)、画像の類似性による検索(searchByBase64searchByItemId

  • タグ管理 -- タグの作成、名前変更、統合、タググループの管理

  • フォルダ管理 -- フォルダの作成、移動、名前変更、整理

  • 自動ページネーション -- すべてのリストエンドポイントがデフォルトでページネーション結果を返却(offset / limit

  • フィールド選択 -- アイテムリストで fields パラメータを使用して必要なデータのみを返却

エンドポイント

セクション
エンドポイント

Item

get, query, countAll, add, save, open, select, setCustomThumbnail, refreshThumbnail

Folder

get, create, open, save

Tag

get, getRecentTags, getStarredTags, save, merge

Tag Group

get, create, save, remove, addTags, removeTags

Library

info

App

info

AI Search

isInstalled, isReady, isStarting, isSyncing, getSyncStatus, checkServiceHealth, searchByText, searchByBase64, searchByItemId

ページネーション

すべてのリストエンドポイントは自動ページネーションを使用します:

  • デフォルトリミット:50

  • 最大リミット:1000

  • レスポンスに totaloffsetlimit のメタデータを含む

Last updated