Skip to main content
POST
/
api
/
v4
/
images
Upload image file.
curl --request POST \
  --url https://apix.us.amity.co/api/v4/images \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=<string>' \
  --form 'files=<string>' \
  --form 'preferredFilename=<string>' \
  --form accessType=public \
  --form 'altText=<string>' \
  --form file.items='@example-file' \
  --form files.items='@example-file'
[
  {
    "fileId": "<string>",
    "fileUrl": "<string>",
    "type": "image",
    "accessType": "public",
    "altText": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "attributes": {
      "name": "test.jpeg",
      "extension": "jpeg",
      "size": 2107842,
      "mimeType": "image/jpeg",
      "metadata": {
        "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.

Headers

​
Content-Type
string
required

Body

multipart/form-data
​
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.

​
preferredFilename
string
Maximum string length: 1024
​
accessType
enum<string>
default:public

File access type. network type requires authentication to download.

Available options:
public,
network
​
altText
string

Alternative text for the file. Not compatible with files property.

Maximum string length: 180

Response

Image Upload Result

​
fileId
string

Root file key on cloud storage.

​
fileUrl
string

url to download the file

​
type
enum<string>

File type.

Available options:
image,
file,
video
Example:

"image"

​
accessType
enum<string>
default:public

File access type. network type requires authentication to download.

Available options:
public,
network
​
altText
string

Alternative text for the file.

​
createdAt
string<date-time>

The date/time when a file is uploaded.

​
updatedAt
string<date-time>

The date/time when a file is updated.

​
attributes
object