Skip to main content
POST
Upload a file

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

The file to upload, sent as multipart/form-data with a single field named file. Maximum size is 20 MB. Accepted MIME types are application/pdf, image/jpeg, image/png, image/heic, image/tiff.

file
file
required

The file to upload. Maximum size is 20 MB. Accepted MIME types are application/pdf, image/jpeg, image/png, image/heic, image/tiff.

Response

File uploaded successfully.

A file that has been uploaded to HIFI.

id
string

Public file identifier.

Example:

"file_9aB0xY4mNpXwZ7bV1aLdt"

createdAt
string<date-time>

Timestamp when the file was uploaded, in ISO 8601 format.

Example:

"2026-07-01T10:30:00.000Z"

fileName
string

Original name of the uploaded file.

Example:

"passport.pdf"

size
integer

Size of the file in bytes.

Example:

245760

mimeType
enum<string>

MIME type of the uploaded file.

Available options:
application/pdf,
image/jpeg,
image/png,
image/heic,
image/tiff
Example:

"application/pdf"