Additionally, a file can be sent with:.
file
is an uploaded file)Content-Type
. No additional
properties can be set along the request dataThe 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.
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
file required | string The file in base64 encoded format. |
isPublic | boolean The File visibility. If public a permalink is provided. |
name | string The file name used for downloading. |
description | string The file description. |
tags | Array of strings The tags list. |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
id | string <= 50 characters The resource ID. Defaults to UUID v4. |
name | string Original File name. |
extension | string The File extension. |
description | string The File description. |
tags | Array of strings The tags list. |
mime | string Enum: "image/png" "image/jpeg" "image/gif" "application/pdf" "audio/mpeg" The mime type. |
size | integer The File size in bytes. |
width | integer Image width, applicable to images only. |
height | integer Image height, applicable to images only. |
sha1 | string Hash sum of the file. |
createdTime | string <date-time> The upload date/time. |
updatedTime | string <date-time> The latest update date/time. |
isPublic | boolean Is the file available publicly (without authentication). If true, the permalink in the _links section contains the public URL. |
Array of SelfLink (object) or FileDownloadLink (object) or SignedLinkLink (object) or PermalinkLink (object) >= 3 items The links related to resource. |
{- "file": "R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs=",
- "isPublic": false,
- "name": "logo.png",
- "description": "My file description",
- "tags": [
- "test",
- "tags"
]
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "string",
- "extension": "string",
- "description": "string",
- "tags": [
- "string"
], - "mime": "image/png",
- "size": 0,
- "width": 0,
- "height": 0,
- "sha1": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "isPublic": true,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}
]
}