Video Livestream Requests
POST/vision/livestream/:registration
This endpoint returns the vehicle's livestream links. This endpoint uses partial success:
- Cameras that succeed are returned in
data - Cameras that fail are listed in
failed_cameraswith reason - HTTP 200 is returned even if some (or all) cameras fail
This allows you to show working cameras to the user immediately while indicating which cameras are unavailable.
Requesting multiple cameras: Cameras share the vehicle's own cellular connection, which
has limited bandwidth, so they are not all streamed simultaneously. Response time increases
with the number of cameras requested rather than staying flat. If the connection can't keep
up, the affected cameras fail quickly (typically within ~30 seconds) rather than hanging, and
are reported in failed_cameras so you still get the cameras that succeeded. data is always
ordered by camera ID regardless of which camera responded first.
If the registration does not exist, or is not accessible to your account, the endpoint returns HTTP 404. Both cases give the same response.
Note: This service is available exclusively for Cartrack Vision API enabled accounts. If you do not have access (HTTP 403), contact our sales representative."
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 422
- 500
- 503
Successful operation
The request body is declared as JSON but cannot be parsed, or is not a JSON object or array. Nothing was processed.
Unauthorized access. Authentication is required.
Access is forbidden. The user does not have permission to access this resource, or the account is not currently active.
The requested resource was not found.
The request conflicts with the current state of the resource.
Validation failed for the input parameters.
Internal server error.
Service temporarily unavailable. The request did not complete and can be retried after the number of seconds in the Retry-After header, when one is sent.
Response Headers
Seconds to wait before retrying. Sent with db_busy and db_pool_timeout.