Vehicle Front Image Detailed Extraction API

Overview

We have created a generative AI solution to find the details of the vehicle using a vehicle image. The API takes a front image of the vehicle as input and gives the vehicle number and fastag installation information on the vehicle.

The endpoint of the API is /vehicle-front-image-detailed

API Input and Sample Output

Curl:

curl --location 'https://api-preproduction.signzy.app/api/v3/vehicle-extraction/vehicle-front-image-detailed' \
--header 'Authorization: xxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
    "vehicleFrontImage": "https://persist.signzy.tech/api/files/1220630585/download/dc9bd4af3b7944ba889533169921c3e1dcd2fb9270a946ad93ad151f038b77e4.jpg"
}'

Input Parameters	Parameter Description	Data Type	Required
vehicleFrontImage	The parameter is the image link of the vehicle. This link contains the front image of the vehicle with the vehicle's number plate and top section of the vehicle front	string	yes

Output:

{
    "error": {
        "name": "error",
        "message": "/vehicleFrontImage/ is required",
        "status": 400,
        "reason": "VALIDATION_REQUEST",
        "type": "Bad Request",
        "statusCode": "400"
    }
}

Output Parameter	Description	Parameter Data Type
vehicleNumber	This parameter is the registration number of the vehicle	string
confidence score of vehicle number	This parameter provides confidence score of vehicle number.	string
vehicleNumberPlateColourBg	The parameter provided information on the color of the vehicle	string
confidence score of vehicle number plate colourbg	This parameter provides confidence score on detection of vehicle number plate colour.	string
typeOfVehicle	This parameter provides information on the type of vehicle (i.e. private vehicle, buses, etc.)	string
confidence score of type of vehicle	This parameter provides confidence score on detection type of vehicle (i.e. private vehicle, buses, etc.)	string
fasTagAffixed	It gives a flag if the fastag is present in the vehicle or not. It gives a flag of true or false	string
confidence score of fasTag affixed	This parameter provides confidence score on fasTag affiction on vehicle image provided.	string
vehicleManufacturerName	This parameter provides information of vehicle manufacturer.	string
confidence score of vehicle manufacturer name	This parameter provides confidence score of vehicle manufacturer name identified from image.	string
overall Confidence Score	This parameter provides overall confidence score of the input.	string

Status Codes:

Code	status	Description
200	Success	The request is completed
400	Bad Request	The vehicle image URL provided in the input parameters is incorrect
404	Invalid Vehicle Image	This is not a valid Vehicle image
409	Upstream Error	Error in fetching data from upstream
500	Internal Server Error	Something is broken. This is usually a temporary error, for example in a high-load situation.or if an endpoint is temporarily having issues. Try again later.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].