# Fluxiom

Digital asset management for teams. Upload, organize, search, and share files through a web interface or REST API.

## Getting Started

1. Sign up for a free 30-day trial at https://fluxiom.com/pricing
2. Choose a plan: Starter, Team, or Business
3. Your account lives at https://YOURSUBDOMAIN.fluxiom.com
4. API access is available immediately with your login credentials

Signup: https://secure.fluxiom.com/signup/starter
Pricing: https://fluxiom.com/pricing
Support: support@fluxiom.com

---

## API

Base URL: https://SUBDOMAIN.fluxiom.com/api/REQUEST.json
Authentication: HTTP Basic Auth over HTTPS.

### Account

#### Get Account Info

```
GET /api/account
```

#### Response

```json
{
  "updated_on": "2009-08-19T22:00:00Z",
  "billing_email": "billing@acme.example.com",
  "stats": {
    "used_space": "8456140",
    "available_space": "30056314932"
  },
  "country": "AT",
  "trial": "false",
  "branding_info": {
    "title": "Acme",
    "logo": "/branding/logo.png",
    "bottom_color": "#32302E",
    "top_color": "#000000",
    "font_color": "#ffffff",
    "updated": "2010-05-24T22:00:00Z"
  },
  "account_holder_id": "1",
  "plan": "Basic",
  "branding": "active",
  "billing_address": "Jane Smith Acme Inc 123 Main St New York NY 10001",
  "created_on": "2009-08-19T22:00:00Z",
  "subdomain": "acme"
}
```

### Assets

#### Get Assets

```
GET /api/assets
```

#### Parameters

| query | string | search term |
| tags | string | tag names or IDs, comma separated |
| page | integer | current page number (defaults to 1) |
| per_page | integer | number of items per page (max. 100) |

#### Response

```json
   {
      "title":"fluxiom logo",
      "thumb_url":"/t/01pzjkkxl051ol/18552/0/ebc62ck6w8p7c5nodq9_64.jpg",
      "id":18552,
      "filename":"logo.gif",
      "description":"The fluxiom logo"
   },
   ...
```

#### Get Single Assets

```
GET /api/assets/ID
```

#### Response

```json
{
   "metadata_alpha_channel":"true",
   "size":9462,
   "metadata_bits_per_sample":"40",
   "metadata_orientation":"0",
   "title":"fluxiom logo",
   "content_type":"image/gif",
   "created_on":"2010-07-21",
   "metadata_resolution_height":"0",
   "metadata_resolution_width":"0",
   "metadata_pixel_height":"70",
   "tags":[
      {
         "tag":"fluxiom",
         "id":101
      },
      ...
   ],
   "id":323569,
   "updated_on":"2010-07-21",
   "metadata_profile_name":"iMac",
   "version":0,
   "user_id":"7915",
   "metadata_pixel_width":"208",
   "filename":"logo.gif",
   "metadata_color_space":"RGB",
   "thumb_url":"/t/01pzjkkxl051ol/18552/0/ebc62ck6w8p7c5nodq9_64.jpg",
   "description":"the fluxiom logo",
   "metadata_type":"Graphics Interchange Format (GIF)"
}
```

#### Download Asset

```
GET /api/assets/download/ID
```

#### Response

```
HTTP 200 OK (+ file data)
```

#### Create Asset

```
POST /api/assets
```

#### Parameters

| file | postdata | (required) |
| title | string | |
| description | string | |
| tags | string | tag names or IDs, comma separated |

#### Response

```json
{
  "size": 9462,
  "title": "fluxiom logo",
  "content_type": "image/gif",
  "created_on": "2010-07-21",
  "tags": [
    {
      "tag": "design",
      "id": 23
    },
    {
      "tag": "print",
      "id": 84
    }
  ],
  "id": 18555,
  "updated_on": "2010-07-21",
  "version": 0,
  "user_id": "35",
  "filename": "logo.gif",
  "thumb_url": "/images/assets/thumbs/generating-preview.gif",
  "description": "the fluxiom logo"
}
```

#### Update Asset

```
PUT /api/assets/ID
```

#### Parameters

| title | string | |
| description | string | |
| tags | string | tag names or IDs, comma separated |

#### Response

```json
{
  "metadata_alpha_channel": "true",
  "size": 9462,
  "metadata_bits_per_sample": "40",
  "metadata_orientation": "0",
  "title": "fluxiom logo updated",
  "content_type": "image/gif",
  "created_on": "2010-07-21",
  "metadata_resolution_height": "0",
  "metadata_resolution_width": "0",
  "metadata_pixel_height": "70",
  "tags": [
    {
      "tag": "design",
      "id": 23
    }
  ],
  "id": 18555,
  "updated_on": "2010-07-21",
  "metadata_profile_name": "iMac",
  "version": 0,
  "user_id": "35",
  "metadata_pixel_width": "208",
  "filename": "logo.gif",
  "metadata_color_space": "RGB",
  "thumb_url": "/t/01pzjkkxlark0zrggckj0vjxtqr051ol/18555/0/ebfj2u7as0x43sakq2r5e4ipcoivi2s02e_64.jpg",
  "description": "the fluxiom logo updated",
  "metadata_type": "Graphics Interchange Format (GIF)"
}
```

#### Delete Asset

```
DELETE /api/assets/ID
```

#### Response

```
HTTP 200 OK
```

#### Get Asset Versions

```
GET /api/assets/ID/versions
```

#### Response

```json
   {
      "comment":null,
      "size":9462,
      "content_type":"image/gif",
      "created_on":"2010-07-21",
      "metadata":{
         "alpha_channel":"1",
         "pixel_height":"70",
         "color_space":"RGB",
         "pixel_width":"208",
         "bits_per_sample":"40",
         "profile_name":"iMac",
         "type":"Graphics Interchange Format (GIF)",
         "orientation":"0",
         "resolution_height":"0",
         "resolution_width":"0"
      },
      "id":18630,
      "updated_on":"2010-07-21",
      "version":4,
      "user_id":"35",
      "filename":"logo.gif"
   },
   ...
```

#### Get Single Asset Version

```
GET /api/assets/ID/versions/VID
```

#### Response

```json
{
  "comment": "new version",
  "size": 9462,
  "content_type": "image/gif",
  "created_on": "2010-07-21",
  "metadata": {
    "alpha_channel": "1",
    "pixel_height": "70",
    "color_space": "RGB",
    "pixel_width": "208",
    "bits_per_sample": "40",
    "profile_name": "iMac",
    "type": "Graphics Interchange Format (GIF)",
    "orientation": "0",
    "resolution_height": "0",
    "resolution_width": "0"
  },
  "id": 18628,
  "updated_on": "2010-07-21",
  "version": 2,
  "user_id": "35",
  "filename": "logo.gif"
}
```

#### Create Asset Version

```
POST /api/assets/ID/versions
```

#### Parameters

| file | postdata |
| comment | string |

#### Response

```json
{
  "comment": "new version",
  "size": 9462,
  "content_type": "image/gif",
  "created_on": "2010-07-21",
  "metadata": {
    "alpha_channel": "1",
    "pixel_height": "70",
    "color_space": "RGB",
    "pixel_width": "208",
    "bits_per_sample": "40",
    "profile_name": "iMac",
    "type": "Graphics Interchange Format (GIF)",
    "orientation": "0",
    "resolution_height": "0",
    "resolution_width": "0"
  },
  "id": 18628,
  "updated_on": "2010-07-21",
  "version": 2,
  "user_id": "35",
  "filename": "logo.gif"
}
```

### Tags

#### Get Tags

```
GET /api/tags
```

#### Response

```json
{
"tag":"acme",
"id":9762,
"documents_count":3,
"stages_count":0
},
{
"tag":"fluxiom",
"id":13409,
"documents_count":20,
"stages_count":1
},
...

```

#### Get Single Tag

```
GET /api/tags/ID
```

#### Response

```json
{
  "tag": "fluxiom",
  "id": 13409,
  "documents_count": 20,
  "stages_count": 1
}
```

#### Create Tag

```
POST /api/tags
```

#### Parameters

| tag | string |

#### Response

```json
{
  "tag": "new tag",
  "id": 14168
}
```

#### Update Tag

```
PUT /api/tags/ID
```

#### Parameters

| tag | string |

#### Response

```json
{
  "tag": "renamed tag",
  "id": 14168,
  "documents_count": 0,
  "stages_count": 0
}
```

#### Delete Tag

```
DELETE /api/tags/ID
```

#### Response

```
HTTP 200 OK
```

### Users

#### Get Users

```
GET /api/users
```

#### Response

```json
   {
      "created_on":"2009-03-24T09:05:02+01:00",
      "id":22,
      "last_name":"Smith",
      "email":"jane@acme.example.com",
      "first_name":"Jane",
      "permissions": [
        "login",
        "manage_assets"
      ],
      "updated_on":"2010-07-15T16:52:18+02:00"
   },
   ...
```

#### Get Single User

```
GET /api/users/ID
```

#### Response

```json
{
  "created_on": "2009-03-24T09:05:02+01:00",
  "id": 22,
  "last_name": "Smith",
  "email": "jane@acme.example.com",
  "first_name": "Jane",
  "permissions": ["login", "manage_assets"],
  "updated_on": "2010-07-15T16:52:18+02:00"
}
```

#### Get Current User

```
GET /api/user
```

#### Response

```json
{
  "created_on": "2009-03-24T09:05:02+01:00",
  "id": 22,
  "last_name": "Smith",
  "email": "jane@acme.example.com",
  "first_name": "Jane",
  "permissions": ["login", "manage_assets"],
  "updated_on": "2010-07-15T16:52:18+02:00"
}
```

---

## Help

### Basics

- [Welcome to Fluxiom](https://fluxiom.com/help/welcome)
- [Upload files](https://fluxiom.com/help/uploading-files)
- [Recent activity](https://fluxiom.com/help/activity)
- [Keyboard shortcuts](https://fluxiom.com/help/keyboard-shortcuts)
- [Light and dark mode](https://fluxiom.com/help/dark-mode)
- [Text formatting](https://fluxiom.com/help/text-formatting)
- [Using Fluxiom on mobile](https://fluxiom.com/help/mobile)

### Find

- [Find files](https://fluxiom.com/help/search)
- [Organize with tags](https://fluxiom.com/help/tags)
- [Create and manage tags](https://fluxiom.com/help/manage-tags)
- [Apply tags to files](https://fluxiom.com/help/apply-tags)
- [Preview and inspect files](https://fluxiom.com/help/inspect)
- [File versions](https://fluxiom.com/help/versions)
- [Print contact sheets](https://fluxiom.com/help/print-contact-sheets)

### Share

- [Share files](https://fluxiom.com/help/share-files)
- [Stages](https://fluxiom.com/help/stages)
- [Inbox](https://fluxiom.com/help/inbox)
- [RSS feeds](https://fluxiom.com/help/rss-feeds)

### Account

- [Users and permissions](https://fluxiom.com/help/users)
- [Your profile](https://fluxiom.com/help/profile)
- [Reset password](https://fluxiom.com/help/reset-password)
- [Account owner](https://fluxiom.com/help/account-owner)
- [Branding](https://fluxiom.com/help/branding)
- [Plans and storage](https://fluxiom.com/help/plans)
- [Billing](https://fluxiom.com/help/billing)
- [Export data](https://fluxiom.com/help/export-data)
- [Cancel account](https://fluxiom.com/help/cancel-account)

### Resources

- [Browser support](https://fluxiom.com/help/browser-support)
- [API](https://fluxiom.com/help/api)
- [Service status](https://fluxiom.com/help/status)

---

## API Quick Reference

| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | /api/account | Get Account Info |
| GET | /api/assets | Get Assets |
| GET | /api/assets/ID | Get Single Assets |
| GET | /api/assets/download/ID | Download Asset |
| POST | /api/assets | Create Asset |
| PUT | /api/assets/ID | Update Asset |
| DELETE | /api/assets/ID | Delete Asset |
| GET | /api/assets/ID/versions | Get Asset Versions |
| GET | /api/assets/ID/versions/VID | Get Single Asset Version |
| POST | /api/assets/ID/versions | Create Asset Version |
| GET | /api/tags | Get Tags |
| GET | /api/tags/ID | Get Single Tag |
| POST | /api/tags | Create Tag |
| PUT | /api/tags/ID | Update Tag |
| DELETE | /api/tags/ID | Delete Tag |
| GET | /api/users | Get Users |
| GET | /api/users/ID | Get Single User |
| GET | /api/user | Get Current User |