v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB
Files

Upload a file

Upload a file.

post/lucca-files/api/uploads

Headers

Accept'application/json' required

HTTP request header used for content-negotiation.

Content-Type'multipart/form-data' required

HTTP response header used for content-negotiation.

Response

Created

idstring uuid
namestring

File name.

createdAtstring date-time

UTC timestamp of the moment this file was uploaded.

deletedAtstring nullable

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

contentLengthinteger

File size in bytes.

contentType'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'
extensionstring

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

totalPagesinteger

Number of pages of a document file.

Example response

{
  "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
}