---
source: sighthound-developer-portal
url: https://dev.sighthound.com/vehicle-analytics/rest-api/quickstart/preview/
markdown-url: https://dev.sighthound.com/vehicle-analytics/rest-api/quickstart/preview.md
title: "Preview - Vehicle Analytics"
content-type: text/markdown
---

> For AI agents: a documentation index is available at [llms.txt](https://dev.sighthound.com/llms.txt). Markdown versions are available at matching `.md` URLs.

# Preview - Vehicle Analytics

The Sighthound Cloud API returns bounding box coordinates and attributes for any vehicles and license plates detected in an image. For vehicles, the attributes include "vehicleType" (make, model, generation) and "color". For license plates, the attributes include the "lpString" (characters from the plate) and "region" (e.g. Florida, Germany, etc.). An example response is available at the bottom of this page.

## Sighthound Cloud API Request

Three different endpoints are available in this preview. The main `/v2/vehicle` endpoint will return results from both US and EU license plate regions. The `/v2/vehicle/us` and `/v2/vehicle/eu` endpoints will force the returned license plate region to be in their respective regions (e.g. you will never get a Florida region when using the `/v2/vehicle/eu` endpoint). Choose the one that is most applicable to your use case.

```json
POST https://preview.sighthoundapi.com/v2/vehicle
POST https://preview.sighthoundapi.com/v2/vehicle/us
POST https://preview.sighthoundapi.com/v2/vehicle/eu
```

### Request Headers

Sighthound will provide an API key to you. This key is required to be in the request header as shown below.

```json
Content-Type: application/json
X-API-Key: YOUR-API-KEY
```

### Request Body

```json
{
    "urlList": [ 
        "https://d1mfcqjbhp6mmy.cloudfront.net/vehicles/audi-sports-car-r8-marlene.jpg"
    ]
}
```

Note: `urlList` is limited to 1 item in the preview API

### Example Request

```json
curl -d '{ "urlList":["https://d1mfcqjbhp6mmy.cloudfront.net/vehicles/audi-sports-car-r8-marlene.jpeg"] }' -H "Content-Type: application/json" -H "X-API-Key: YOUR-API-KEY" -X POST https://preview.sighthoundapi.com/v2/vehicle
```

Note: Update `YOUR-API-KEY` with your actual key.

### Example Response

```json
{
  "apiVersion": {
    "major": 1,
    "minor": 1
  },
  "frameDimensions": {
    "w": 900,
    "h": 620
  },
  "frameSource": "/tmp/cloudv3-image-tmpdir-1659537084813/a073c1e4d344491a868f3ca000d3809a/__vehicles__audi-sports-car-r8-marlene.jpeg",
  "sourceId": "cloud",
  "frameId": "cloud-frame-13-1659537083268",
  "analyticsTimestamp": 1660055701536,
  "frameTimestamp": 1660055701507,
  "metaClasses": {
    "licensePlates": {
      "cloud-lp-11-1659537083268": {
        "attributes": {
          "lpString": {
            "value": "RTBB221",
            "attributeScore": 1,
            "detectionScore": 0.88,
            "updated": true
          },
          "lpRegion": {
            "value": "Germany",
            "attributeScore": 1,
            "detectionScore": 0.88,
            "updated": true
          }
        },
        "firstFrameTimestamp": 1660055701507,
        "class": "licensePlate",
        "bestDetectionTimestamp": 1660055701507,
        "box": {
          "height": 27,
          "width": 119,
          "x": 620,
          "y": 451
        },
        "detectionScore": 0.88,
        "updated": true,
        "links": [
          {
            "metaClass": "vehicles",
            "id": "cloud-car-14-1659537083277"
          }
        ]
      }
    },
    "vehicles": {
      "cloud-car-14-1659537083277": {
        "attributes": {
          "vehicleType": {
            "value": {
              "make": "audi",
              "model": "r8",
              "generation": "2007-2014"
            },
            "attributeScore": 1,
            "detectionScore": 0.94,
            "updated": true
          },
          "color": {
            "value": "white",
            "attributeScore": 1,
            "detectionScore": 0.94,
            "updated": true
          }
        },
        "firstFrameTimestamp": 1660055701507,
        "class": "car",
        "bestDetectionTimestamp": 1660055701507,
        "box": {
          "height": 269,
          "width": 403,
          "x": 429,
          "y": 289
        },
        "detectionScore": 0.94,
        "updated": true,
        "links": [
          {
            "metaClass": "licensePlates",
            "id": "cloud-lp-11-1659537083268"
          }
        ]
      }
    }
  },
  "links": [
    {
      "type": "image",
      "path": "cloud-frame-13-1659537083268.jpg",
      "format": "jpg"
    }
  ],
  "request_id": "a073c1e4d344491a868f3ca000d3809a",
  "engine_version": "",
  "time_analytics_start": 1660055701.497,
  "time_analytics_complete": 1660055701.588
}
```

---

# Agent Instructions

Use this Markdown page as context for Sighthound Developer Portal questions. For broader navigation, read https://dev.sighthound.com/llms.txt. Answer from Sighthound documentation, cite relevant source URLs, and do not ask users to paste secrets, tokens, license keys, or credentials into chat.