Fluxiom API Documentation

The Fluxiom API empowers you to seamlessly integrate Fluxiom with other applications. With its capabilities for asset retrieval, uploading, metadata querying, and more, Fluxiom becomes a seamless part of your existing workflow and toolset.

Are you looking to connect your internal app to Fluxiom? Perhaps you're developing a plugin for your preferred CMS? If your application requires advanced media management, the Fluxiom API is the solution you need!

Constructing the URL

https://SUBDOMAIN.fluxiom.com/api/REQUEST.FORMAT

subdomain	The subdomain of your Fluxiom account.
request	The data you want. The different request types are listed below.
format	The data format ( XML , JSON ) you want to return.

Authentication

Authentication is performed via HTTP Basic authentication, and you’ll need to transmit your username and password along with your request. HTTPS must be used for interacting with the API .

JSON Callbacks

You can add a ?callback parameter to have the results wrapped in a JavaScript function:

curl ... https://SUBDOMAIN.fluxiom.com/api/assets.json?callback=foo

Try it out!

Try the API using curl on the command line:

curl -X GET -u USER:PASSWORD https://SUBDOMAIN.fluxiom.com/api/assets.xml

Get Account Info

JSON XML

GET /api/account

Response

<account>
  <subdomain>wollzelle</subdomain>
  <account_holder_id>1</account_holder_id>
  <billing_address>
    Thomas Pamminger
    Wollzelle GmbH
    Loquaiplatz 12/12
    1060 Vienna
  </billing_address>
  <billing_email>[email protected]</billing_email>
  <country>AT</country>
  <plan ssl="true" stages="true" multiple_users="true" versions="true" branding="true" full_text_search="true">Promo</plan>
  <branding>active</branding>
  <branding_info>
    <title>Wollzelle</title>
    <font_color>#ffffff</font_color>
    <top_color>#426fb3</top_color>
    <bottom_color>#5ebfff</bottom_color>
    <logo>/branding/logo.png</logo>
    <updated type="datetime">2010-02-01T00:00:00+01:00</updated>
  </branding_info>
  <trial>false</trial>
  <stats available_space="39313762738" used_space="3635910222" />
  <created_on type="datetime">2006-03-24T00:00:00+01:00</created_on>
  <updated_on type="datetime">2006-03-24T00:00:00+01:00</updated_on>
</account>

{
  "updated_on": "2009-08-19T22:00:00Z",
  "billing_email": "[email protected]",
  "stats": {
    "used_space": "8456140",
    "available_space": "30056314932"
  },
  "country": "AT",
  "trial": "false",
  "branding_info": {
    "title": "Wollzelle",
    "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": "Thomas Pamminger Wollzelle GmbH Loquaiplatz 12/12 1060 Vienna",
  "created_on": "2009-08-19T22:00:00Z",
  "subdomain": "wollzelle"
}

Get Assets

JSON XML

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

<documents type="array">
  <asset>
    <id type="integer">323569</id>
    <title>fluxiom logo</title>
    <version type="integer">0</version>
    <filename>logo.gif</filename>
    <description/>
    <content-type>image/gif</content-type>
    <thumb_url>/t/0dmqei828xe3f4cpg/323569/0/6xour6vq_64.jpg</thumb_url>
    <size type="integer">5060</size>
    <user-id>7915</user-id>
    <created-on type="date">2010-07-13T13:13:51+02:00</created-on>
    <updated-on type="date">2010-07-13T13:13:51+02:00</updated-on>
    <tags type="array">
      <tag>
        <id type="integer">101</id>
        <tag>fluxiom</tag>
      </tag>
      ...
    </tags>
    <metadata-type>Graphics Interchange Format (GIF)</metadata-type>
    <metadata-resolution-height>0</metadata-resolution-height>
    <metadata-pixel-height>70</metadata-pixel-height>
    <metadata-bits-per-sample>32</metadata-bits-per-sample>
    <metadata-color-space>RGB</metadata-color-space>
    <metadata-resolution-width>0</metadata-resolution-width>
    <metadata-orientation>0</metadata-orientation>
    <metadata-alpha-channel>false</metadata-alpha-channel>
    <metadata-pixel-width>208</metadata-pixel-width>
  </asset>
  ...
</documents>

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

Get Single Assets

JSON XML

GET /api/assets/ID

Response

<asset>
  <id type="integer">323569</id>
  <title>fluxiom logo</title>
  <version type="integer">0</version>
  <filename>logo.gif</filename>
  <description/>
  <content-type>image/gif</content-type>
  <thumb_url>/t/0dmqei828xe3f4cpg/323569/0/6xour6vq_64.jpg</thumb_url>
  <size type="integer">5060</size>
  <user-id>7915</user-id>
  <created-on type="date">2010-07-13T13:13:51+02:00</created-on>
  <updated-on type="date">2010-07-13T13:13:51+02:00</updated-on>
  <tags type="array">
    <tag>
      <id type="integer">101</id>
      <tag>fluxiom</tag>
    </tag>
    ...
  </tags>
  <metadata-type>Graphics Interchange Format (GIF)</metadata-type>
  <metadata-resolution-height>0</metadata-resolution-height>
  <metadata-pixel-height>70</metadata-pixel-height>
  <metadata-bits-per-sample>32</metadata-bits-per-sample>
  <metadata-color-space>RGB</metadata-color-space>
  <metadata-resolution-width>0</metadata-resolution-width>
  <metadata-orientation>0</metadata-orientation>
  <metadata-alpha-channel>false</metadata-alpha-channel>
  <metadata-pixel-width>208</metadata-pixel-width>
</asset>

{
   "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

Download asset

GET /api/assets/download/ID

Response

HTTP 200 OK (+ file data)

Create Asset

JSON XML

POST /api/assets

Parameters

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

Response

<asset>
<id type="integer">18547</id>
  <title>fluxiom logo</title>
  <version type="integer">0</version>
  <filename>logo.gif</filename>
  <description>the fluxiom logo</description>
  <content-type>image/gif</content-type>
  <thumb_url>/images/assets/thumbs/generating-preview.gif</thumb_url>
  <size type="integer">9462</size>
  <user-id>35</user-id>
  <created-on type="date">2010-07-21T11:16:18+02:00</created-on>
  <updated-on type="date">2010-07-21T11:16:18+02:00</updated-on>
  <tags type="array">
    <tag>
      <id type="integer">101</id>
      <tag>fluxiom</tag>
    </tag>
    <tag>
      <id type="integer">102</id>
      <tag>logo</tag>
    </tag>
  </tags>
</asset>

{
  "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

JSON XML

PUT /api/assets/ID

Parameters

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

Response

<asset>
<id type="integer">18547</id>
  <title>fluxiom logo updated</title>
  <version type="integer">0</version>
  <filename>logo.gif</filename>
  <description>the fluxiom logo updated</description>
  <content-type>image/gif</content-type>
  <thumb_url>/t/01pzjkkgckj0vj51ol/18551/0/ebb5o48zhi3si_64.jpg</thumb_url>
  <size type="integer">9462</size>
  <user-id>35</user-id>
  <created-on type="date">2010-07-21T11:21:52+02:00</created-on>
  <updated-on type="date">2010-07-21T11:36:13+02:00</updated-on>
  <tags type="array">
    <tag>
      <id type="integer">23</id>
      <tag>design</tag>
    </tag>
  </tags>
  <metadata-type>Graphics Interchange Format (GIF)</metadata-type>
  <metadata-profile-name>iMac</metadata-profile-name>
  <metadata-resolution-height>0</metadata-resolution-height>
  <metadata-pixel-height>70</metadata-pixel-height>
  <metadata-bits-per-sample>40</metadata-bits-per-sample>
  <metadata-color-space>RGB</metadata-color-space>
  <metadata-resolution-width>0</metadata-resolution-width>
  <metadata-orientation>0</metadata-orientation>
  <metadata-alpha-channel>true</metadata-alpha-channel>
  <metadata-pixel-width>208</metadata-pixel-width>
</asset>

{
  "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

JSON XML

GET /api/assets/ID/versions

Response

<document-versions type="array">
  <version>
    <id type="integer">18630</id>
    <version type="integer">4</version>
    <filename>logo.gif</filename>
    <content-type>image/gif</content-type>
    <size type="integer">9462</size>
    <comment></comment>
    <user-id>35</user-id>
    <created-on type="date">2010-07-21T11:21:52+02:00</created-on>
    <updated-on type="date">2010-07-21T12:18:43+02:00</updated-on>
    <metadata>
      <type>Graphics Interchange Format (GIF)</type>
      <profile-name>iMac</profile-name>
      <resolution-height>0</resolution-height>
      <pixel-height>70</pixel-height>
      <bits-per-sample>40</bits-per-sample>
      <color-space>RGB</color-space>
      <resolution-width>0</resolution-width>
      <orientation>0</orientation>
      <alpha-channel>1</alpha-channel>
      <pixel-width>208</pixel-width>
    </metadata>
  </version>
  ...
</document-versions>

   {
      "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

JSON XML

GET /api/assets/ID/versions/VID

Response

<version>
  <id type="integer">18629</id>
  <version type="integer">3</version>
  <filename>logo.gif</filename>
  <content-type>image/gif</content-type>
  <size type="integer">9462</size>
  <comment>new version</comment>
  <user-id>35</user-id>
  <created-on type="date">2010-07-21T11:21:52+02:00</created-on>
  <updated-on type="date">2010-07-21T12:18:39+02:00</updated-on>
  <metadata>
    <type>Graphics Interchange Format (GIF)</type>
    <profile-name>iMac</profile-name>
    <resolution-height>0</resolution-height>
    <pixel-height>70</pixel-height>
    <bits-per-sample>40</bits-per-sample>
    <color-space>RGB</color-space>
    <resolution-width>0</resolution-width>
    <orientation>0</orientation>
    <alpha-channel>1</alpha-channel>
    <pixel-width>208</pixel-width>
  </metadata>
</version>

{
  "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

JSON XML

POST /api/assets/ID/versions

Parameters

file	postdata
comment	string

Response

<version>
  <id type="integer">18629</id>
  <version type="integer">3</version>
  <filename>logo.gif</filename>
  <content-type>image/gif</content-type>
  <size type="integer">9462</size>
  <comment>new version</comment>
  <user-id>35</user-id>
  <created-on type="date">2010-07-21T11:21:52+02:00</created-on>
  <updated-on type="date">2010-07-21T12:18:39+02:00</updated-on>
  <metadata>
    <type>Graphics Interchange Format (GIF)</type>
    <profile-name>iMac</profile-name>
    <resolution-height>0</resolution-height>
    <pixel-height>70</pixel-height>
    <bits-per-sample>40</bits-per-sample>
    <color-space>RGB</color-space>
    <resolution-width>0</resolution-width>
    <orientation>0</orientation>
    <alpha-channel>1</alpha-channel>
    <pixel-width>208</pixel-width>
  </metadata>
</version>

{
  "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"
}

Get Tags

JSON XML

GET /api/tags

Response

<tags type="array">
  <tag>
    <tag>wollzelle</tag>
    <id type="integer">9762</id>
    <documents-count type="integer">3</documents-count>
    <stages-count type="integer">0</stages-count>
  </tag>
  <tag>
    <tag>fluxiom</tag>
    <id type="integer">13409</id>
    <documents-count type="integer">20</documents-count>
    <stages-count type="integer">1</stages-count>
  </tag>
  ...
</tags>

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

Get Single Tag

JSON XML

GET /api/tags/ID

Response

<tag>
<tag>fluxiom</tag>
<id type="integer">13409</id>
<documents-count type="integer">20</documents-count>
<stages-count type="integer">1</stages-count>
</tag>

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

Create Tag

JSON XML

POST /api/tags

Parameters

tag

string

Response

<tag>
  <tag>new tag</tag>
  <id type="integer">14168</id>
</tag>

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

Update Tag

JSON XML

PUT /api/tags/ID

Parameters

tag

string

Response

<tag>
  <tag>renamed tag</tag>
  <id type="integer">14168</id>
  <documents-count type="integer">0</documents-count>
  <stages-count type="integer">0</stages-count>
</tag>

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

Delete Tag

Delete tag

DELETE /api/tags/ID

Response

HTTP 200 OK

Get Users

JSON XML

GET /api/users

Response

<users type="array">
  <user>
    <id type="integer">5792</id>
    <first_name>Thomas</first_name>
    <last_name>Pamminger</last_name>
    <email>[email protected]</email>
    <created-on type="date">2009-03-24T09:05:02+01:00</created-on>
    <updated-on type="date">2010-07-15T16:52:18+02:00</updated-on>
   <permissions type="array">
      <permission>login</permission>
      <permission>manage_assets</permission>
      ...
    </permissions>
  </user>
  ...
</users>

   {
      "created_on":"2009-03-24T09:05:02+01:00",
      "id":22,
      "last_name":"Pamminger",
      "email":"[email protected]",
      "first_name":"Thomas",
      "permissions": [
        "login",
        "manage_assets"
      ],
      "updated_on":"2010-07-15T16:52:18+02:00"
   },
   ...

Get Single User

JSON XML

GET /api/users/ID

Response

<user>
  <id type="integer">5792</id>
  <first_name>Thomas</first_name>
  <last_name>Pamminger</last_name>
  <email>[email protected]</email>
  <created-on type="date">2009-03-24T09:05:02+01:00</created-on>
  <updated-on type="date">2010-07-15T16:52:18+02:00</updated-on>
  <permissions type="array">
      <permission>login</permission>
      <permission>manage_assets</permission>
      ...
  </permissions>
</user>

{
  "created_on": "2009-03-24T09:05:02+01:00",
  "id": 22,
  "last_name": "Pamminger",
  "email": "[email protected]",
  "first_name": "Thomas",
  "permissions": ["login", "manage_assets"],
  "updated_on": "2010-07-15T16:52:18+02:00"
}

Get Current User

JSON XML

GET /api/user

Response

<user>
  <id type="integer">5792</id>
  <first_name>Thomas</first_name>
  <last_name>Pamminger</last_name>
  <email>[email protected]</email>
  <created-on type="date">2009-03-24T09:05:02+01:00</created-on>
  <updated-on type="date">2010-07-15T16:52:18+02:00</updated-on>
  <permissions type="array">
      <permission>login</permission>
      <permission>manage_assets</permission>
      ...
  </permissions>
</user>

{
  "created_on": "2009-03-24T09:05:02+01:00",
  "id": 22,
  "last_name": "Pamminger",
  "email": "[email protected]",
  "first_name": "Thomas",
  "permissions": ["login", "manage_assets"],
  "updated_on": "2010-07-15T16:52:18+02:00"
}

Browse API Methods…

Account

Get Account Info

Assets

Get Assets
Get Single Assets
Download Asset
Create Asset
Update Asset
Delete Asset
Get Asset Versions
Get Single Asset Version
Create Asset Version

Tags

Get Tags
Get Single Tag
Create Tag
Update Tag
Delete Tag

Users

Get Users
Get Single User
Get Current User

3rd Party Tools

Ruby API wrapper

Have you created a great tool or product based on the Fluxiom API? Tell us about it