url
property when creating a document. This saves you the trouble of hosting the file yourself.
The following file types are supported:
Format | Media Type |
---|---|
application/pdf | |
DOCX | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
These files are intended for temporary use and expire after 24 hours. To store files you intend to use for longer timeframes, use the Library section in your Dashboard.
The Upload resource is the successor to the File resource. The File resource is soft-deprecated but remains available for backward compatibility.
Attributes
The unique identifier of the upload.
Whether the upload is permanent or temporary.Available options are
permanent
and temporary
. Uploads made via the API are temporary.A URL used to reference the uploaded file. This internal URL can be used as input in other fields, like
document.url
.The file’s content cannot be retrieved directly via this URL.The SHA-256 hash of the uploaded file in hexadecimal format.
The size in bytes of the uploaded file.
The format of the uploaded file.Available options are
pdf
and docx
.The date and time the upload was created in format.
Time at which the file will expire in format.If the upload is has a
permanent
retention, this value is null
.