Skip to content

Instantly share code, notes, and snippets.

@PaulMorel
Created November 5, 2020 17:47
Show Gist options
  • Save PaulMorel/1e4a0a64952ee186bf8b12cdf96e3fc2 to your computer and use it in GitHub Desktop.
Save PaulMorel/1e4a0a64952ee186bf8b12cdf96e3fc2 to your computer and use it in GitHub Desktop.
Eagle API Routes

Eagle API Endpoints

What is Eagle?

Eagle is a MacOS and Windows application to organize assets such as images|fonts|audio|video and more. I think of it like a self-hosted visual bookmarking tool like Pinterest|Designspiration|fffound (RIP)|etc.

You can learn more about the application on their website https://eagle.cool/

API Endpoints

On Build 21 released in June 2020|an API was added to Eagle that enables programmatically interacting with the application and its library. You can see it used in their Import from Pinterest tutorial. This allows developers to create extensions, third-party integrations, or custom workflows for Eagle.

However these endponts don't seem to be documented yet. After digging through the application files I found what seems to be the source for the API endpoints.

As I learn more about the API, I'll update this Gist.

The API server runs at http://localhost:41595 when Eagle is running.

Application

Endpoint Method
/ GET
/api/application/info GET

Library

Endpoint Method
/api/library/info GET
/api/library/history GET
/api/library/switch POST

Folder

Endpoint Method
/api/folder/create POST
/api/folder/rename POST
/api/folder/list GET
/api/folder/listRecent GET

Preferences

Endpoint Method
/api/preferences/collect/on GET
/api/preferences/collect/off GET

Script

Endpoint Method
/api/script/inject GET

Item

Endpoint Method
/api/item/addFromPath POST
/api/item/addFromPaths POST
/api/item/addFromURL POST
/api/item/addFromURLs POST
/api/item/addBookmark POST
/api/item/update POST
/api/item/info GET
/api/item/thumbnail GET
/api/item/list GET
/api/item/refreshPalette POST
/api/item/refreshThumbnail POST
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment