API ReferenceFiles

Upload file

Uploads one file, up to 50 MB. Executable and script files are rejected.

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Request

Multipart file upload. The file part is required.

filefileRequired

File to upload. Executable and script files are rejected. Maximum size: 50 MB.

Response

File stored. Reference it by id in extractions and workflow payloads.

idstringOptional

File identifier. Reference it as fileId in extractions and workflow payloads.

fileNamestringOptional
Original file name.
mimeTypestringOptional
Detected media type of the stored file.
sizelongOptional
File size in bytes.
contentUrlstringOptional

Temporary, pre-signed URL to download the file content directly. Valid for a limited time; request the file again to obtain a fresh URL.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
405
Method Not Allowed Error
406
Not Acceptable Error
409
Conflict Error
413
Content Too Large Error
415
Unsupported Media Type Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error