Get media download URL

This API provides the ability to retrieve the download URL for images, PDFs, and video files associated with an inspection, issue, or action.

🚧

This API is not compatible with Get an inspection (legacy). Instead, please use Retrieve the selected media for a given inspection.

βœ…

This API is compatible with:

This API relies on both an id and token returned from one of the listed APIs above, this will be returned in an object that looks similar to the following:

{
  "id": "xyz1238b-4b01-48a5-b2d6-fb96003ceaf2",
  "token": "xyz12380bd503c836778a2021d01e2cbae2d0d57171504cde61d403024f7a97a",
  "filename": "My Cool Image.jpeg",
  "media_type": "MEDIA_TYPE_IMAGE"
},

Once this API is called, it will return an object with a temporary url property (valid for 20 minutes) that can be used to download or stream the requested media content.

{
  "url": "https://app.safetyculture.com/xyz123"
}
Path Params
string
required

The unique identifier for the media item.

Query Params
string
required

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

string

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.

string
enum
Defaults to MEDIA_TYPE_NONE_UNSPECIFIED

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.
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json