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=@example-file \
  --form files=@example-file \
  --form 'preferredFilename=<string>' \
  --form accessType=public \
  --form 'altText=<string>'
[
  {
    "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

Response

200
application/json

Image Upload Result

The response is of type object[].