Create a file

v1.0.0

Additionally, a file can be sent with:.

multipart/form-data POST request: in this case all property names are the same as the JSON ones (file is an uploaded file)
file body request: the file body is sent as the request body, with the appropriate Content-Type. No additional properties can be set along the request data

The following file types only are allowed:

If using a Publishable Api Key, only private files can be created. The files can later on be modified or used using a secret API key.

Input

{
  "type": "object"
}

Output

{
  "type": "object",
  "properties": {
    "_links": {
      "type": "array",
      "description": "The links related to resource.",
      "items": {
        "type": "object"
      }
    },
    "createdTime": {
      "description": "The upload date/time.",
      "type": "object"
    },
    "description": {
      "type": "string",
      "description": "The File description."
    },
    "extension": {
      "type": "string",
      "description": "The File extension."
    },
    "height": {
      "type": "integer",
      "description": "Image height, applicable to images only."
    },
    "id": {
      "type": "object"
    },
    "isPublic": {
      "type": "boolean",
      "description": "Is the file available publicly (without authentication). If true, the permalink in the _links section contains the public URL."
    },
    "mime": {
      "type": "string",
      "description": "The mime type.",
      "enum": [
        "image/png",
        "image/jpeg",
        "image/gif",
        "application/pdf",
        "audio/mpeg"
      ]
    },
    "name": {
      "type": "string",
      "description": "Original File name."
    },
    "sha1": {
      "type": "string",
      "description": "Hash sum of the file."
    },
    "size": {
      "type": "integer",
      "description": "The File size in bytes."
    },
    "tags": {
      "type": "array",
      "description": "The tags list.",
      "items": {
        "type": "string"
      }
    },
    "updatedTime": {
      "description": "The latest update date/time.",
      "type": "object"
    },
    "width": {
      "type": "integer",
      "description": "Image width, applicable to images only."
    }
  }
}