Skip to navigation

Initiate multi-part blob upload

Blobs may be uploaded using multi-part upload. This endpoint initiates the upload process - blob parts can then be uploaded in multiple blob parts.

Multipart Upload

If a blob is larger than 10MB, it should be uploaded in multiple parts using the following endpoints:

Each part must be at least 5MB in size, except for the last part. We recommend keeping each part to under 10MB when uploading.

Each part has a partNumber and an eTag. The part number can be any number between 1 to 10,000, inclusive - this number should be unique and identifies the order of the part in the final blob. The eTag of a part is returned in the API response - this eTag must be specified when completing the upload in order to ensure the server has received all the expected parts.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequired<=1000 characters
Name of the blob
typeenumRequired

One of RAW_FILE or VISUALIZATION. If VISUALIZATION, the blob may be displayed as an image preview.

Allowed values:
mimeTypestringOptional<=100 charactersDefaults to application/octet-stream

eg. application/jpeg

Response

Created
idstringOptionalformat: "uuid"

The universally unique identifier (UUID) for the blob.

mimeTypestringOptional<=100 characters

eg. application/jpeg

namestringOptional<=1000 characters
Name of the blob
typeenumOptional

One of RAW_FILE or VISUALIZATION. If VISUALIZATION, the blob may be displayed as an image preview.

Allowed values:
uploadStatusenumOptional
Allowed values:

Errors

400
Bad Request Error