Skip to main content
POST
/
api
/
v3
/
files
Upload file.
curl --request POST \
  --url https://apix.us.amity.co/api/v3/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=<string>' \
  --form 'files=<string>' \
  --form fullImage=true \
  --form 'preferredFilename=<string>' \
  --form accessType=public \
  --form file.items='@example-file' \
  --form files.items='@example-file'
{
  "status": "<string>",
  "data": [
    {
      "fileId": "<string>",
      "accessType": "public",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "attributes": {
        "name": "<string>",
        "extension": "<string>",
        "size": 123,
        "mimeType": "<string>",
        "metadata": {
          "exif": {},
          "gps": {},
          "height": 123,
          "width": 123,
          "isFull": true
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

Information of file to be created. It will be applied to every attachment

​
file
file[]
required

An array containing a single file.

​
files
file[]
deprecated

An array of files. Must not be provided at the same time as file.

​
fullImage
boolean | null
​
preferredFilename
string
Maximum string length: 1024
​
accessType
enum<string>
default:public

File access type. network type requires authentication to download.

Available options:
public,
network

Response

File Upload Result

​
status
string
​
data
object[]