Skip to main content
POST
This endpoint requires authentication and the uploadFiles permission. The maximum file size is 10MB.

Path Parameters

string
required
The storage provider to use. One of:
  • s3: Amazon S3 storage
  • local: Local file storage

Request Headers

string
required
The MIME type of the file being uploaded
string
required
Must include the filename parameter, e.g. attachment; filename="example.jpg"

Request Body

The request body should contain the raw file data.

Response

string
File’s unique identifier (UUID)
string
Original filename
string
URL to access the file
string
Storage key/path of the file
string
MIME type of the file
integer
File size in bytes
string
Storage provider used (s3 or local)
object
Provider-specific metadata
string
UUID of the user who uploaded the file
string
Upload timestamp in ISO 8601 format
string
Last update timestamp in ISO 8601 format

Error Responses

object
Error details when the request fails
Common error cases:
  • 400 Bad Request: Invalid provider or missing filename
  • 401 Unauthorized: Missing or invalid access token
  • 403 Forbidden: Missing required permission
  • 413 Payload Too Large: File exceeds size limit