Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

Filestack File Uploader - Quick Start Guide

All official SDK quick starts in one place. Compiled March 2026 from github.com/filestack.

Discord

Join the community on Discord


Filestack is a file upload and content management API that powers file handling for thousands of applications. The File Uploader (also called the Picker) is an embeddable widget that lets users upload from their device, cloud drives (Google Drive, Dropbox, Box, OneDrive, and more), or via URL - with no backend infrastructure required.

Get your free API key: Sign Up for free


SDK Quick Reference

SDK Install Min Version
JavaScript (Web) npm install filestack-js Browser + Node.js
React npm install filestack-react React 18+
Angular npm i @filestack/angular filestack-js Angular 12+
Python pip install filestack-python Python 3+
PHP composer require filestack/filestack-php PHP 7+
Ruby gem install filestack Ruby 2.5+
Ruby on Rails gem "filestack-rails" Rails 4+
Java implementation "org.filestack:filestack-java:1.0.1" Java 8+
Android implementation "com.filestack:filestack-android:6.0.0" Android (Kotlin/Java)
iOS (Swift) pod "Filestack", "~> 3.0.1" iOS 14+ / Swift 4.2+
Swift (low-level) pod "FilestackSDK", "~> 3.0.0" iOS 14+ / Swift 4.2+
Go go get github.com/filestack/filestack-go Go 1.13+

Table of Contents

  1. JavaScript
  2. React
  3. Angular
  4. Python
  5. PHP
  6. Ruby
  7. Ruby on Rails
  8. Java
  9. Android
  10. iOS
  11. Swift SDK
  12. Go
  13. Next Steps & Resources

1. JavaScript

GitHub: filestack/filestack-js Full guide: docs/javascript.md Examples: examples/javascript/

The core JavaScript SDK supports both browser and Node.js environments. It powers the Filestack Picker widget and the full processing/upload API.

npm install filestack-js

Quickest start - CDN (no build step):

<script src="//static.filestackapi.com/filestack-js/4.x.x/filestack.min.js"></script>
<button id="picker">Upload File</button>
<script>
  const client = filestack.init("YOUR_API_KEY");
  client.picker({ onUploadDone: (res) => console.log(res) }).open();
  document.getElementById("picker").addEventListener("click", () => picker.open());
</script>

See full guide


2. React

GitHub: filestack/filestack-react Full guide: docs/react.md Examples: examples/react/

A wrapper around filestack-js with ready-to-use React components: PickerOverlay, PickerInline, and PickerDropPane.

npm install filestack-react filestack-js
import { PickerOverlay } from "filestack-react";

function App() {
  return (
    <PickerOverlay
      apikey="YOUR_API_KEY"
      onUploadDone={(res) => console.log("Uploaded:", res.filesUploaded[0].url)}
    />
  );
}

See full guide


3. Angular

GitHub: filestack/filestack-angular Full guide: docs/angular.md Examples: examples/angular/

Official Angular library wrapping filestack-js with picker components and a FilestackService for Observables.

npm i @filestack/angular filestack-js

See full guide


4. Python

GitHub: filestack/filestack-python Full guide: docs/python.md Examples: examples/python/

Server-side SDK with Client for uploading and Filelink for managing already-uploaded files.

pip install filestack-python
from filestack import Client

client = Client("YOUR_API_KEY")
filelink = client.upload(filepath="path/to/file")
print(filelink.url)

See full guide


5. PHP

GitHub: filestack/filestack-php Full guide: docs/php.md Examples: examples/php/

FilestackClient for uploads and Filelink for transformations and file management.

composer require filestack/filestack-php

See full guide


6. Ruby

GitHub: filestack/filestack-ruby Full guide: docs/ruby.md Examples: examples/ruby/

Server-side uploads, transformations, and file management for Ruby apps.

gem install filestack

See full guide


7. Ruby on Rails

GitHub: filestack/filestack-rails Full guide: docs/ruby-on-rails.md

Rails plugin that injects the Filestack Picker into views via form helpers and layout tags.

# Gemfile
gem 'filestack-rails'

See full guide


8. Java

GitHub: filestack/filestack-java Full guide: docs/java.md Examples: examples/java/

Upload, transformation, cloud, and file management APIs. Also the underlying engine for the Android SDK.

// build.gradle
implementation 'org.filestack:filestack-java:1.0.1'

See full guide


9. Android

GitHub: filestack/filestack-android Full guide: docs/android.md Examples: examples/android/

Full-featured picker UI (FsActivity) supporting local files, camera, and 10+ cloud sources.

// app/build.gradle
implementation 'com.filestack:filestack-android:6.0.0'

See full guide


10. iOS

GitHub: filestack/filestack-ios Full guide: docs/ios.md Examples: examples/ios/

Full Filestack Picker UI and programmatic upload for Swift and Objective-C. Requires Xcode 11+, Swift 4.2+, iOS 14+.

# Podfile
pod 'Filestack', '~> 3.0.1'

See full guide


11. Swift SDK

GitHub: filestack/filestack-swift Full guide: docs/swift.md Examples: examples/swift/

Lower-level Swift SDK (FilestackSDK) for programmatic uploads without the picker UI. Use this to build a fully custom upload UI.

# Podfile
pod 'FilestackSDK', '~> 3.0.0'

See full guide


12. Go

GitHub: filestack/filestack-go Full guide: docs/go.md Examples: examples/go/

Official Go SDK for file uploads, transformations, and file link operations.

go get github.com/filestack/filestack-go

See full guide


Next Steps & Resources

Once you've uploaded your first file, explore these Filestack capabilities:

Feature Description
Image & Video Transformations Resize, crop, convert formats, add watermarks, and apply AI-powered enhancements via URL parameters
Security (Policy + Signature) Restrict access, add expiry, and protect uploads with a Security object at client initialization
Workflows Trigger automated processing (virus scanning, content moderation, document conversion) on every upload
Storage Backends Connect your own S3, GCS, Azure Blob, Dropbox, or Rackspace bucket as the upload destination

Links

Developer Portal dev.filestack.com
Documentation filestack.com/docs
API Reference filestack.github.io/filestack-js
GitHub github.com/filestack
Discord discord.com/invite/58TRKSRPxD
Quick Start (official) filestack.com/docs/getting-started/quick-start

Compiled March 2026 from official Filestack SDK repositories.