Skip to navigation

Complete File

Beta

Makes a pending file ready once its bytes are uploaded, and returns it, with its download_url if the key has file_read. Calling it on a file that is already ready returns the file.

Returns 409 if the bytes haven’t been uploaded yet, or if what was uploaded doesn’t match the file’s size and sha256. Returns 404 for a file that has expired or was deleted, including a pending file not completed within a day of its creation.

Requires the file_create permission. Only a key with file_read, or the key that created the file, can complete it; any other key gets 404.

Authentication

AuthorizationBearer

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

Path parameters

inbox_idstringRequired
The ID of the inbox.
file_idstringRequired
ID of the file. A UUID.

Response

This endpoint returns an object.
content_typestring

The file’s MIME type, such as application/pdf. Defaults to application/octet-stream.

created_atdatetime
When the file was created.
emailstring
Email address of the inbox.
file_idstring
ID of the file. A UUID.
inbox_idstring
The ID of the inbox.
namestring
The path's last segment. A download saves under this name.
pathstring

Where the file lives in its inbox’s drive, such as reports/q3.pdf. Unique within the inbox. Segments are separated by /, with no leading or trailing /, no empty, . or .. segment, no \ and no control or invisible characters. At most 1,024 bytes, and at most 255 bytes per segment. Stored in Unicode NFC, so two spellings of one name are one path. Case is kept.

sha256string

The base64 encoding of the file’s 32-byte SHA-256 digest, as S3’s x-amz-checksum-sha256 takes it (44 characters, ending in =). S3 refuses an upload whose bytes don’t match.

sizeinteger

Size of the file in bytes. At most 104,857,600 (100 MiB).

statusenum

pending until its bytes are uploaded and the upload is completed, then ready. Only a ready file has a download URL. A pending file is deleted if it isn’t completed within a day.

Allowed values:
updated_atdatetime
When the file last changed, such as when its upload was completed.
download_expires_atdatetimeOptional

When download_url stops working. Never after the file’s own expiry.

download_urlstringOptional

A signed URL that downloads the file’s bytes, named by name. No API key is needed to use it, so treat it as a secret. It works until download_expires_at, at most an hour, even after the file is deleted. Get the file again for a fresh one.

expires_atdatetimeOptional

When the file expires. After it, the file is gone from get and list and its path is free; its bytes are deleted soon after. Absent for a file that never expires.

Errors

400
Validation Error
403
File Forbidden Error
404
Not Found Error
409
Conflict Error