Skip to main content

POST /uploads

Description​

Uploads a binary file to the server and returns a json object with the file id, name, and url

This route accepts an HTTP POST multipart request sent to the /uploads endpoint.

Payload​

The server expects a binary file sent through a multipart/form-data request. Like all multipart MIME requests, the body should include:

  • a Content-Disposition header set to form-data
    • a name attribute with the value upload
    • a filename field containing the original name of the uploaded file
  • a Content-Type header specifying the file's data type

Only one file is allowed in each request.

Example:


------WebKitFormBoundarySlwgXDBw7kcKSI4p
Content-Disposition: form-data; name="upload"; filename="myImage.png"
Content-Type: image/png

------WebKitFormBoundarySlwgXDBw7kcKSI4p--

Response​

The server responds with a JSON object containing the file's id, name, and url.

The isCover property shows if the image is a cover image (true) or not (false).

Example:

{
   "id":4,
   "name":"myImage.png",
   "url":"http://localhost:3000/uploads/4/myImage.png",
   "isCover":false
}

The HTTP status code indicates whether the request was successful (response.status == 200) or encountered an error (response.status == 500).

Related articles: Working with server