Flag of Ukraine   We stand with the brave people of Ukraine. Stop the war. Find out how you can help.


The @uppy/instagram plugin lets users import files from their Instagram account.

A Companion instance is required for the @uppy/instagram plugin to work. Companion handles authentication with Instagram, downloads the pictures and videos, and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.

import Instagram from '@uppy/instagram'

uppy.use(Instagram, {
  // Options

Try it live


If you are using the uppy package, you do not need to install this plugin manually.

This plugin is published as the @uppy/instagram package.

Install from NPM:

npm install @uppy/instagram

In the CDN package, the plugin class is available on the Uppy global object:

const { Instagram } = Uppy


Dashboard plugin is recommended as a container to all Provider plugins, including Instagram. If you are using Dashboard, it comes with all the necessary styles for Instagram as well.

⚠️ If you are feeling adventurous, and want to use Instagram plugin separately, without Dashboard, make sure to include @uppy/provider-views/dist/style.css (or style.min.css) CSS file. This is experimental, not officially supported and not recommended.


The @uppy/instagram plugin has the following configurable options:

uppy.use(Instagram, {
  target: Dashboard,
  companionUrl: 'https://companion.uppy.io/',

id: 'Instagram'

A unique identifier for this plugin. It defaults to 'Instagram'.

title: 'Instagram'

Configures the title / name shown in the UI, for instance, on Dashboard tabs. It defaults to 'Instagram'.

target: null

DOM element, CSS selector, or plugin to mount the Instagram provider into. This should normally be the @uppy/dashboard plugin.

companionUrl: null

URL to a Companion instance.

companionHeaders: {}

Custom headers that should be sent along to Companion on every request.

companionAllowedHosts: companionUrl

The valid and authorised URL(s) from which OAuth responses should be accepted.

This value can be a String, a Regex pattern, or an Array of both.

This is useful when you have your Companion running on several hosts. Otherwise, the default value should be good enough.

companionCookiesRule: 'same-origin'

This option correlates to the RequestCredentials value, which tells the plugin whether to send cookies to Companion.

locale: {}

export default {
  strings: {
    pluginNameInstagram: 'Instagram',