For the complete documentation index, see llms.txt. This page is also available as Markdown.

Folder

The Folder API allows you to list, create, and manage folders in the Eagle library.

Endpoints Overview

Method
Endpoint
Description

GET

/api/v2/folder/get

List all folders

POST

/api/v2/folder/get

List folders (body)

POST

/api/v2/folder/create

Create a new folder

POST

/api/v2/folder/update

Update a folder


GET /api/v2/folder/get

List folders with optional filtering. Returns paginated results.

Query Parameters

  • id string (optional) — Return a single folder by ID

  • ids string (optional) — Comma-separated folder IDs

  • isSelected boolean (optional) — Return the currently selected folder

  • isRecent boolean (optional) — Return recently used folders

  • offset integer (optional) — Pagination offset, default 0

  • limit integer (optional) — Pagination limit, default 50, max 1000

Response

Examples


POST /api/v2/folder/get

Same as GET, but accepts filter parameters in the JSON body.

Request Body

  • id string (optional) — Folder ID

  • ids string[] (optional) — Array of folder IDs

  • isSelected boolean (optional) — Currently selected folder

  • isRecent boolean (optional) — Recently used folders

  • offset integer (optional) — Pagination offset, default 0

  • limit integer (optional) — Pagination limit, default 50, max 1000

Example


POST /api/v2/folder/create

Create a new folder in the library.

Request Body

  • name string (required) — Folder name

  • description string (optional) — Folder description

  • parent string (optional) — Parent folder ID. If omitted, creates at root level.

Response

Returns the newly created folder object.

Examples


POST /api/v2/folder/update

Update an existing folder's metadata. Only the fields you include will be modified.

Request Body

  • id string (required) — The folder ID to update

Modifiable fields:

  • name string (optional) — New folder name

  • description string (optional) — New description

  • tags string[] (optional) — Replace folder tags

  • iconColor string (optional) — Folder icon color. One of: red, orange, yellow, green, aqua, blue, purple, pink

  • parent string | null (optional) — Move folder to a new parent. Set to null to move to root.

Response

Returns the updated folder object.

Examples


Folder Properties

Folders returned by the API contain the following properties:

Property
Type
Description

id

string

Unique folder ID

name

string

Folder name

description

string

Folder description

children

Object[]

Array of child folder objects

modificationTime

integer

Last modification timestamp

tags

string[]

Array of tag names

iconColor

string

Icon color name

imageCount

integer

Number of items in this folder

Last updated