Vehicle Detection API Guide

Vehicle Detection API

Identify and classify vehicles in an image, with a bounding box, vehicle type and confidence score for every detection.

Select version

Download document

Overview

The Vehicle Detection API identifies and classifies vehicles in an image. It returns a bounding box, a vehicle type and a confidence score for each detection, which suits traffic monitoring, parking management and automated toll collection.

Details

Request URL

https://faceapi.mxface.ai/api/Vehicle/VehicleDetect

Method type

POST

Headers

Content-Type : application/json

Subscriptionkey : xxxxxxxxxxx

Request body

{
  "encoded_image": "string"
}

Request parameters

encoded_image YesString

Base64 encoded string of image.

Response body

[
  {
    "code": 0,
    "message": "string",
    "errorMessage": "string",
    "vehicles": [
      {
        "boundingBox": {
          "x": "number",
          "y": "number",
          "height": "number",
          "width": "number"
        },
        "vehicleType": "string",
        "confidence": "float"
      }
    ]
  }
]

Response parameters

code int

Status code.

message string

Status message.

errorMessage string

A human readable description of the error.

vehicles array

List of detected vehicles.

boundingBox object

Bounding box of the detected vehicle.

x int

x-edge of the vehicle.

y int

y-edge of the vehicle.

height int

Height of the vehicle from y.

width int

Width of the vehicle from x.

vehicleType string

Type of the detected vehicle.

confidence float

Confidence of the detected vehicle.

Errors

200

Success

400

Invalid request. Please pass valid json with all required parameters.
Not valid biometric data or invalid format.
The input is not a valid Base-64 string.

401

Access denied due to an invalid subscription key or the wrong API endpoint. Make sure to provide a valid key for an active subscription.

500

Something went wrong, please try again later.