For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
GuidesIntegrationsAPI ReferencesRelease notes
GuidesIntegrationsAPI ReferencesRelease notes
  • Introduction
    • Overview
    • Quick Start
    • Projects
    • Billing
  • Uploading
    • Overview
      • Overview
      • Installation
        • Overview
        • Plugin structure
        • Extension points
        • Icons & Translations
        • Runtime API
        • Activity UI
        • Complete example
        • Built-in plugins
      • HTML forms
      • Built-in image editor
      • Security settings
      • Breaking changes
    • Uploading files with API
    • File analysis on upload
  • Optimization
    • Overview
  • Transformations
  • Delivery
    • Overview
    • On-the-fly operations
    • CDN settings
    • Proxy
  • Security
    • Overview
    • Validation and moderation
    • Signed uploads
    • Signed URLs
    • Unsafe content moderation
    • Malware protection
    • HIPAA workflows
  • Storage
    • Uploadcare storage
    • Cloudflare R2
    • Google Cloud Storage
    • Azure Blob Storage
  • File management
    • Overview
    • Managing files
    • File groups
    • Webhooks
    • Arbitrary file metadata
  • CLI
    • Overview
    • Configuration
  • Migration
    • Migration to Uploadcare
    • Migration from Filestack
Dashboard
LogoLogo
On this page
  • What plugins can do
  • In this section
UploadingFile UploaderPlugin API

Plugin API

Was this page helpful?
Previous

Plugin structure & registration

Next
Built with

The Plugin API lets you extend the File Uploader without forking or patching the library. Plugins can add upload sources, custom UI activities, per-file actions, file transformation hooks, icons, translations, and config options as a self-contained unit.

What plugins can do

CapabilityAPI method
Add a source to the pickerregisterSource
Add a custom activity panelregisterActivity
Add a per-file action buttonregisterFileAction
Transform files before uploadregisterFileHook
Register an SVG iconregisterIcon
Add translation stringsregisterL10n
Declare a custom config optionregisterConfig

In this section

If you are starting from scratch, begin with Plugin structure & registration, then move to Extension points.

  • Plugin structure & registration — how to write a plugin, register it, and clean up after it
  • Extension points — registerSource, registerActivity, registerFileAction, registerFileHook, registerConfig
  • Icons & Translations — registerIcon, registerL10n
  • Runtime API — pluginApi.config, pluginApi.activity, pluginApi.files
  • Activity UI — CSS classes and elements for building activity UIs
  • Complete example — full Unsplash source plugin walkthrough
  • Built-in plugins — plugins that ship with the uploader