Skip to main content
POST
/
lucca-files
/
api
/
uploads
Upload a file
curl --request POST \
  --url https://{host}/lucca-files/api/uploads \
  --header 'Accept: <accept>' \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: multipart/form-data' \
  --form form=@example-file
{
  "id": "552cb7db-b7e2-4f39-a675-c4b140f41eea",
  "name": "test.pdf",
  "createdAt": "2023-10-24T12:19:54.7243377Z",
  "deletedAt": null,
  "contentLength": 95683,
  "contentType": "application/pdf",
  "extension": ".pdf",
  "totalPages": 3
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

​
Accept
string
required

HTTP request header used for content-negotiation.

Allowed value: "application/json"
​
Content-Type
string
required

HTTP response header used for content-negotiation.

Allowed value: "multipart/form-data"

Body

multipart/form-data
​
form
file

Response

201 - application/json

Created

A file resource.

​
id
string<uuid>
​
name
string

File name.

​
createdAt
string<date-time>

UTC timestamp of the moment this file was uploaded.

​
deletedAt
string | null

UTC timestamp of the moment this file was deleted. When null, file is not deleted.

​
contentLength
integer

File size in bytes.

Required range: x >= 1
​
contentType
enum<string>
Available options:
eml message/rfc822,
image/heic,
image/heif,
image/jpe,
image/jpg,
image/pjpeg,
image/gif,
image/bmp,
image/tif,
image/tiff,
image/x-dcraw,
image/x-jb2,
image/x-jbig2,
image/x-jpf,
image/x-ms-bmp,
image/x-panasonic-raw,
image/x-pcx,
image/x-icon,
image/x-png,
image/vnd.microsoft.icon,
image/webp,
image/x-portable-anymap,
text/plain,
text/csv,
text/rtf,
text/calendar,
text/comma-separated-values,
text/markdown,
application/pdf,
application/msword,
application/xls,
application/x-csv,
application/ms-excel,
application/vnd.ms-office,
application/vnd.ms-word,
application/vnd.ms-outlook,
application/vnd.ms-powerpoint,
application/vnd.ms-excel,
application/vnd.oasis.opendocument.text,
application/vnd.oasis.opendocument.spreadsheet,
application/vnd.oasis.opendocument.presentation,
application/vnd.oasis.opendocument.graphics,
application/vnd.openxmlformats-officedocument.wordprocessingml.document,
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
application/vnd.openxmlformats-officedocument.presentationml.presentation,
application/vnd.openxmlformats-officedocument.presentationml.slideshow,
application/vnd.openxmlformats-officedocument.presentationml.template,
application/x-7z-compressed,
application/rar,
application/x-rar,
application/zip,
application/csv,
application/rtf,
application/text,
application/txt,
application/x-pdf
​
extension
string

Inferred from content-type (e.g.: '.pdf', '.doc', '.txt', etc...).

​
totalPages
integer

Number of pages of a document file.

Required range: x >= 0