Skip to main content
POST
/
files
/
upload
{
  "id": "72fa9618-8f89-4a37-9b33-7e1178a24a67",
  "name": "example.png",
  "size": 1024,
  "extension": "png",
  "mime_type": "image/png",
  "created_by": "6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13",
  "created_at": 1577836800
}

Authorizations

​
Authorization
string
header
required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with 'Bearer '. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Body

multipart/form-data

File upload request. Requires multipart/form-data.

​
file
file
required

The file to be uploaded. Supported image types: png, jpg, jpeg, webp, gif.

​
user
string
required

User identifier, defined by the developer's rules, must be unique within the application.

Response

File uploaded successfully.

​
id
string<uuid>

ID of the uploaded file.

​
name
string

File name.

​
size
integer

File size (bytes).

​
extension
string

File extension.

​
mime_type
string

File mime-type.

​
created_by
string<uuid>

End-user ID who uploaded the file.

​
created_at
integer

Creation timestamp (Unix epoch).

Example:

1577836800