Get details for a media retrieval request
This endpoint returns media information corresponding to a retrieval ID. Retrieval IDs are associated to prior media retrieval requests. Urls provided by this endpoint expire in 8 hours.
<b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
To use this endpoint, select Read Media Retrieval under the Safety & Cameras category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
Request
- Base URLhttps://api.samsara.com
- AuthHTTP bearer
Query parameters
Retrieval ID associated with this media capture request. Examples: 2308cec4-82e0-46f1-8b3c-a3592e5cc21e
Response
OK response.
Example response
{
"data": {
"media": [
{
"auxcamSerial": "CSS6-23A-HJF",
"availableAtTime": "2019-11-11T14:00:12-04:00",
"cameraRole": "leftMirrorMount",
"endTime": "2019-06-13T19:08:25Z",
"input": "dashcamDriverFacing",
"mediaType": "image",
"startTime": "2019-06-13T19:08:25Z",
"status": "available",
"urlInfo": {
"url": "https://sample.s3.url.com/image.jpeg",
"urlExpiryTime": "2019-11-11T14:00:12-04:00"
},
"vehicleId": "1234"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.