Camera Media Access
Camera Media Access APIs allow you to capture on-demand images and request stored video footage from vehicle and asset cameras. These APIs support automated visual verification, incident investigation, compliance workflows, and safety operations.
This overview covers the Camera Media Access endpoints.
Initiate image capture
- Endpoint:
POST /v1/image_captures - Description: Requests a single on-demand image from a selected camera position on a vehicle or asset. The request is processed asynchronously and returns a request ID.
- Use Case: Automate visual verification or capture a current image without manually refreshing images in the Motive Dashboard.
Fetch the captured image
- Endpoint:
GET /v1/image_captures/{camera_type}/{request_id} - Description: Retrieves the status and image URL for a previously submitted image capture request.
- Use Case: Check whether the image is ready and retrieve it when processing is complete.
Fetch the video recall quota of your company
- Endpoint:
GET /v1/video_recall_requests/quota - Description: Retrieves your company’s video recall quota usage, remaining minutes, total quota, and rate limit information.
- Use Case: Check available quota before submitting a video recall request.
Fetch details of a specific video recall
- Endpoint:
GET /v1/video_recall_requests/{id} - Description: Retrieves the status and details of a specific video recall request, including camera media information and download URLs when available.
- Use Case: Monitor video processing and retrieve the requested footage after the recall is complete.
Fetch the available timelines for a vehicle
- Endpoint:
GET /v1/video_recall_requests/vehicles/available_timelines - Description: Returns the video timeline segments available for a specified vehicle.
- Use Case: Verify that footage is available for the requested time range before creating a video recall request.
Fetch the available timelines for an asset
- Endpoint:
GET /v1/video_recall_requests/assets/available_timelines - Description: Returns the video timeline segments available for a specified asset.
- Use Case: Verify that footage is available for the requested asset and time range before creating a video recall request.
Create a video recall request
- Endpoint:
POST /v1/video_recall_requests - Description: Submits an asynchronous request to retrieve video footage for a specified vehicle or asset and time range. You can request regular or timelapse footage.
- Use Case: Retrieve video footage for incident investigation, compliance reviews, driver coaching, or operational workflows.
