Sign in

v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Media

Get media download URL

get/media/v1/download/{id}

Path parameters

idstring required

The unique identifier for the media item.

Query parameters

tokenstring required

The given token, unique for each media item, to grant access.

download_as_attachment_namestring

Indicates the object should be downloaded as an attachment and saved with the given name. At the least, the file name should contain a name plus a 3-letter file extension e.g. test.png, conditions.pdf, a.jpg.

media_type'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV'

The media type associated with the download request.

  • MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP).
  • MEDIA_TYPE_VIDEO: A video file (MP4, MOV).
  • MEDIA_TYPE_PDF: A PDF document.
  • MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC).
  • MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS).
  • MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT).
  • MEDIA_TYPE_CSV: A CSV file.

Response

A successful response.

urlstring

The url has been deprecated for upload paths. For download paths, it is still valid. The signed URL that can be used to upload or download the media to the S12 system. UploadSignedURL is only valid for 5 minutes and DownloadSignedURL for 20 minutes; this is from the first bytes received i.e. if upload started within 5 minutes, it is still valid even if upload takes 10 minutes to complete. It is safe to reject a signed URL and re-request a new Upload/Download Signed URL.