> ## Documentation Index
> Fetch the complete documentation index at: https://docs.supernote.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PluginFileAPI

> File-related API index.

<Note>
  APIs in this section operate directly on files.
</Note>

## Import

```ts wrap theme={null}
import { PluginFileAPI } from 'sn-plugin-lib';
```

## Return Convention

Most async APIs return [`APIResponse<T>`](/en/api-reference/supernote-plugin/types/api-response). Read `result` only when `success === true`.

## Methods

* [getElements](/en/api-reference/supernote-plugin/plugin-file-api/get-page-trails)
* [replaceElements](/en/api-reference/supernote-plugin/plugin-file-api/replace-trails)
* [insertElements](/en/api-reference/supernote-plugin/plugin-file-api/insert-trails)
* [modifyElements](/en/api-reference/supernote-plugin/plugin-file-api/modify-trails)
* [deleteElements](/en/api-reference/supernote-plugin/plugin-file-api/delete-elements)
* [getTitles](/en/api-reference/supernote-plugin/plugin-file-api/get-titles)
* [getKeyWords](/en/api-reference/supernote-plugin/plugin-file-api/get-key-words)
* [insertKeyWord](/en/api-reference/supernote-plugin/plugin-file-api/insert-key-word)
* [deleteKeyWord](/en/api-reference/supernote-plugin/plugin-file-api/delete-key-word)
* [getNoteTotalPageNum](/en/api-reference/supernote-plugin/plugin-file-api/get-note-total-page-num)
* [getPageSize](/en/api-reference/supernote-plugin/plugin-file-api/get-page-size)
* [generateNotePng](/en/api-reference/supernote-plugin/plugin-file-api/generate-note-png)
* [searchFiveStars](/en/api-reference/supernote-plugin/plugin-file-api/search-five-stars)
* [createNote](/en/api-reference/supernote-plugin/plugin-file-api/create-note)
* [removeNotePage](/en/api-reference/supernote-plugin/plugin-file-api/remove-note-page)
* [insertNotePage](/en/api-reference/supernote-plugin/plugin-file-api/insert-note-page)
* [clearLayerElements](/en/api-reference/supernote-plugin/plugin-file-api/clear-page-layer-data)
* [getLayers](/en/api-reference/supernote-plugin/plugin-file-api/get-layers)
* [modifyLayers](/en/api-reference/supernote-plugin/plugin-file-api/modify-layers)
* [insertLayer](/en/api-reference/supernote-plugin/plugin-file-api/insert-layer)
* [deleteLayers](/en/api-reference/supernote-plugin/plugin-file-api/delete-layers)
* [sortLayers](/en/api-reference/supernote-plugin/plugin-file-api/sort-layers)
* [getMarkPages](/en/api-reference/supernote-plugin/plugin-file-api/get-mark-pages)
* [generateMarkThumbnails](/en/api-reference/supernote-plugin/plugin-file-api/generate-mark-thumbnails)
* [clearMarkElements](/en/api-reference/supernote-plugin/plugin-file-api/clear-mark-trails)
* [getNotePageTemplate](/en/api-reference/supernote-plugin/plugin-file-api/get-note-page-template)
* [generateNoteTemplatePng](/en/api-reference/supernote-plugin/plugin-file-api/generate-note-template-png)
* [getNoteType](/en/api-reference/supernote-plugin/plugin-file-api/get-note-type)
* [getFileMachineType](/en/api-reference/supernote-plugin/plugin-file-api/get-file-machine-type)
* [getElementCounts](/en/api-reference/supernote-plugin/plugin-file-api/get-element-counts)
* [getElementNumList](/en/api-reference/supernote-plugin/plugin-file-api/get-element-num-list)
* [getElement](/en/api-reference/supernote-plugin/plugin-file-api/get-element)
* [getLastElement](/en/api-reference/supernote-plugin/plugin-file-api/get-last-element)
