Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
73 lines (59 sloc) 2.24 KB


The immutable files API is available via the multipart/form-data Content-Type for image uploads.

{% hint style="warning" %} Accepted file types are jpg, jpeg, png and gif. {% endhint %}

The File Object

Attribute Type Description
id string The unique identifier for this file
type string The type represents the object being returned
link object The file link object
file_name string The name of the file
mime_type string The mime type of the file
file_size integer The size of the file
public boolean Is this file public or not
meta object The additional meta object
links object The file links object

The file link object

Attribute Type Description
link.href string The publicly available URL for this file

The file meta object

Attribute Type Description
meta.dimensions.width integer The width of the file
meta.dimensions.height integer The height of the file
meta.timestamps.created_at string The creation date of the file

The file links object

Attribute Type Description
links.self string The URL of this file object

Example response

  "data": {
    "id": "272d3ff0-5034-4986-8786-0ff97450745d",
    "type": "file",
    "link": {
      "href": ""
    "file_name": "image.jpg",
    "mime_type": "image/jpeg",
    "file_size": 20953,
    "public": true,
    "meta": {
      "dimensions": {
        "width": 1600,
        "height": 800
      "timestamps": {
        "created_at": "2017-08-14T10:47:45.191Z"
    "links": {
      "self": ""