Skip to navigation
Buckets

fileUpload

Get upload instructions for a public or protected file. Upload the bytes using the returned method and headers before expiresAt, at most 900 seconds later. Then ingest hostedUrl into the same bucket with the same fileAccess settings. For protected files, submit ingest before expiresAt; public uploads can be ingested later. Uploads without a policy also work when file protection is disabled.

Authentication

X-API-Keystring
API Key authentication via header

Path parameters

bucketIdintegerRequired

Request

This endpoint expects an object.
fileNamestringRequired1-255 characters
fileTypeenumRequired

The type of document (one of the currently supported file types)

fileAccessobject or nullOptional

Settings for the uploaded file. Send the same settings when ingesting hostedUrl. Omit or send null to use the bucket and account settings. Checked before upload; requires file protection to be enabled.

Response

Upload instructions
uploadIdstringformat: "uuid"
uploadUrlstringformat: "uri"
hostedUrlstringformat: "uri"
expiresAtstringformat: "date-time"
methodenum
Allowed values:
headersmap from strings to strings
effectiveFileAccessobjectOptional
Settings used for this upload. If mode is protected, submit ingest before expiresAt. Public uploads can be ingested later.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
503
Service Unavailable Error