Skip to content
Vision API
/
/
List available videos

List available videos

Request

Returns a paginated list of available videos based on filtering specifications. Use this endpoint to poll whether requested videos have been prepared and are available for downloading. Each element specifies the video source, time range, and provides a downloadable link (which may be valid temporarily).

Security
apiKey
Query
customerIdstringrequired

Unique identifier for the customer

Example:customerId=123e4567-e89b-12d3-a456-426614174000
truckIdstring

Filter by truck identifier

Example:truckId=truck-5201
cameraIdstring

Filter by camera identifier or placement name

Example:cameraId=front
requestIdstring

Filter by a specific video request ID

Example:requestId=req-abc123-def456
startTimestring, (date-time)

Filter videos starting from this ISO 8601 timestamp

Example:startTime=2026-02-04T08:30:00Z
endTimestring, (date-time)

Filter videos ending before this ISO 8601 timestamp

Example:endTime=2026-02-04T08:35:00Z
pageinteger, >= 1

Page number for pagination

Default:1
Example:page=1
pageSizeinteger, [ 1 .. 100 ]

Number of results per page

Default:20
Example:pageSize=20
curl -i -X GET \
  'https://docs.haulerhero.com/_mock/vision/video-hero/v1/videos?customerId=123e4567-e89b-12d3-a456-426614174000&truckId=truck-5201&cameraId=front&requestId=req-abc123-def456&startTime=2026-02-04T08%3A30%3A00Z&endTime=2026-02-04T08%3A35%3A00Z&page=1&pageSize=20' \
  -H 'API-KEY: YOUR_API_KEY_HERE'

Responses

Videos retrieved successfully

Bodyapplication/json
successbooleanrequired

Whether the request was successful

Example:true
dataobjectrequired
Response
{
  "success": true,
  "data": {
    "videos": [ … ],
    "pagination": { … }
  }
}