Skip to main content
POST
/
api
/
v1
/
files
/
upload
Upload a file
curl --request POST \
  --url https://api.example.com/api/v1/files/upload \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
{
  "file": {
    "filename": "<string>",
    "size": 123,
    "mime_type": "<string>",
    "path": "<string>"
  },
  "success": true,
  "message": "File uploaded successfully"
}

Headers

authorization
string | null

Body

multipart/form-data
file
file
required

File to upload

Response

Successful Response

Response schema for file upload.

file
FileMetadataResponse · object
required

Uploaded file metadata

success
boolean
default:true

Upload success status

message
string
default:File uploaded successfully

Success message