Request on-demand video

Request

Initiates the process of video discovery and preparation for export. Specify the video source (customer, truck, camera) and a time range (start and end timestamps in ISO 8601 format) for the video to be requested.

Security

apiKey

Bodyapplication/jsonrequired

customerIdstringrequired

Unique identifier or name for the customer

Example:"123e4567-e89b-12d3-a456-426614174000"

truckIdstringrequired

Truck identifier, ideally the same ID used for work order and routing specification

Example:"truck-5201"

cameraIdstringrequired

Camera identifier on the truck. Can use commonly understood naming for camera placement (e.g., "front", "rear", "left", "right") or a predefined numbering scheme (e.g., "1", "2", "3").

Example:"front"

startTimestring, (date-time)required

Start of the requested video time range in ISO 8601 format

Example:"2026-02-04T08:30:00Z"

endTimestring, (date-time)required

End of the requested video time range in ISO 8601 format

Example:"2026-02-04T08:35:00Z"

curl -i -X POST \
  https://docs.haulerhero.com/_mock/vision/video-hero/v1/videos/requests \
  -H 'API-KEY: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "truckId": "truck-5201",
    "cameraId": "front",
    "startTime": "2026-02-04T08:30:00Z",
    "endTime": "2026-02-04T08:35:00Z"
  }'

Responses

Video request accepted and processing has begun

Bodyapplication/json

successbooleanrequired

Whether the request was accepted

Example:true

requestIdstringrequired

Unique identifier for the video request, used for polling status

Example:"req-abc123-def456"

statusstringrequired

Current status of the video request

Enum:"processing""ready""failed"

Example:"processing"

messagestring

Human-readable status message

Example:"Video request accepted. Poll GET /video-hero/v1/videos to check availability."

Response

{
  "success": true,
  "requestId": "req-abc123-def456",
  "status": "processing",
  "message": "Video request accepted. Poll GET /video-hero/v1/videos to check availability."
}