VehicleAPIOptions

Interface An object containing configuration options for the Vehicle API client.

Properties

Name	Type	Description
apiKey	string	The API key to be used for authentication.
cloudServiceRegion?	"AUTO" | "EU" | "US"	The cloud service region to use - "AUTO" for latency-based automatic routing (default), "EU" for Europe and "US" for the United States. Has no effect if endpoint is also set.
disableCallStatistics?	boolean	The service uses your call statistics, which were generated based on the list of locations (countries and states) determined when reading your previously sent images, to decide which ANPR engines should be run when processing your uploaded images. If you want the service to ignore your call statistics, for example because you use the service with images from different locations around the world, you can turn this feature off by setting the property value to true.
disableImageResizing?	boolean	The service resizes large images to Full HD resolution by bicubic interpolation. Resizing can make reading many times faster, but it can reduce the recognition efficiency. If you don't want the service to resize your images, turn this feature on by setting the property value to true. By disabling image resizing, you may also need to enable wide range analysis.
enableUnidentifiedLicensePlate?	boolean	If you want to receive text results read from unidentified license plate types as well, you can turn this feature on by setting the property value to true. Attention! The number of false positives can be much higher.
enableWideRangeAnalysis?	boolean	If you cannot guarantee that the uploaded image meets all the required parameters (see the Input Images tab on the How To Use page), you can turn on the wide-range analysis by setting this property's value to true. Attention! The duration of the analysis may increase several times.
endpoint?	string	The URL of the API endpoint to call. Optional if cloudServiceRegion is also set. Overrides cloudServiceRegion if both properties are set.
inputImageLocation	InputImageLocation	The expected geographic region of the license plates in the uploaded image. You can either use one of the presets in the Locations object or provide your own settings in a { region: string; location?: string } object. region is required but location is optional.
maxReads?	number	An optional parameter, it specifies the maximum number of vehicle/license plate searches per image. Use this parameter carefully, because every search increases the processing time. The system will stop searching when there is no more vehicle/license plate in the image, or the number of searches reaches the value of maxreads. Its value is 1 by default, the maximum is 5.
regionOfInterest?	RegionOfInterest	The region of interest in the image to be analyzed.
retryCount?	number	How many times the request should be retried in case of a 5XX response status code. Default: 3.
services	SelectedServices	The services to use. At least one of anpr (Automated Number Plate Recognition), mmr (Make and Model Recognition) and adr (Dangerous Goods Pictogram Recognition) must be specified.

---

Source: vehicle/options.ts:4