> This page is for version Dev.
> For other versions, use one of these documentation indexes:
> - 3.3.0 (default): https://docs.nvidia.com/vss/3.3.0/llms.txt
> - Dev: https://docs.nvidia.com/vss/dev/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/vss/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/vss/_mcp/server.

# Get calibration configuration

GET https://ai.nvidia.com/api/v3.3/analytics/config/calibration

Retrieve calibration configuration from the database, optionally for a specific sensor or as an empty result when no configuration is found.

Reference: https://docs.nvidia.com/vss/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-get-calibration-config

## Request

### Query parameters

- `sensorId` (string, optional)
- `emptyIfNotFound` (boolean, optional, default: true) — If set to true, empty calibration will be returned when calibration config is not found.

## Response

### 200

Successful Operation.

- `version` (string, required)
- `osmURL` (string, required)
- `calibrationType` (enum, required)
  - Allowed values: `geo`, `cartesian`, `image`
- `sensors` (list of CalibrationSensorsItems, required)
- `rois` (list of CalibrationRoisItems, optional)
- `tripwires` (list of CalibrationTripwiresItems, optional)
- `corridors` (list of CalibrationCorridorsItems, optional)

## Errors

### 400 Bad Request Error

Bad Request. This response will be sent if any of the required params are not present or if extra params are passed.

- `error` (string, required)

### 404 Not Found Error

Resource Not Found

- `error` (string, required)

### 422 Unprocessable Entity Error

Unprocessable Entity

- `error` (string, required)

### 500 Internal Server Error

Internal Server Error

- `error` (string, required)

## Types

### CalibrationSensorsItems

- `type` (string, required)
- `id` (string, required)
- `origin` (CalibrationSensorsItemsOrigin, required)
- `geoLocation` (CalibrationSensorsItemsGeoLocation, required)
- `coordinates` (CalibrationSensorsItemsCoordinates, required)
- `scaleFactor` (double, required)
- `attributes` (list of CalibrationSensorsItemsAttributesItems, required)
- `place` (list of CalibrationSensorsItemsPlaceItems, required)
- `imageCoordinates` (list of CalibrationSensorsItemsImageCoordinatesItems, required)
- `globalCoordinates` (list of CalibrationSensorsItemsGlobalCoordinatesItems, required)
- `translationToGlobalCoordinates` (CalibrationSensorsItemsTranslationToGlobalCoordinates, optional)
- `group` (CalibrationSensorsItemsGroup, optional)
- `region` (CalibrationSensorsItemsRegion, optional)
- `intrinsicMatrix` (list of list of double, optional)
- `extrinsicMatrix` (list of list of double, optional)
- `cameraMatrix` (list of list of double, optional)
- `homography` (list of list of double, optional)
- `rois` (list of CalibrationSensorsItemsRoisItems, optional)
- `tripwires` (list of CalibrationSensorsItemsTripwiresItems, optional)

### CalibrationRoisItems

- `id` (string, required)
- `roiCoordinates` (list of CalibrationRoisItemsRoiCoordinatesItems, required)
- `sensors` (list of string, required)
- `groups` (list of string, required)
- `type` (string, optional)
- `restrictedObjectTypes` (list of string, optional)
- `confinedObjectTypes` (list of string, optional)

### CalibrationTripwiresItems

- `id` (string, required)
- `wire` (CalibrationTripwiresItemsWire, required)
- `direction` (CalibrationTripwiresItemsDirection, required)
- `sensors` (list of string, required)
- `groups` (list of string, required)

### CalibrationCorridorsItems

- `name` (string, required)
- `sensors` (list of string, required)
- `directions` (list of string, required)
- `length` (double, required)

### CalibrationSensorsItemsOrigin

- `lat` (double, required)
- `lng` (double, required)

### CalibrationSensorsItemsGeoLocation

- `lat` (double, required)
- `lng` (double, required)

### CalibrationSensorsItemsCoordinates

- `x` (double, required)
- `y` (double, required)
- `z` (double, optional)

### CalibrationSensorsItemsAttributesItems

- `name` (string, required)
- `value` (string, required)

### CalibrationSensorsItemsPlaceItems

- `name` (string, required)
- `value` (string, required)

### CalibrationSensorsItemsImageCoordinatesItems

- `x` (double, required)
- `y` (double, required)

### CalibrationSensorsItemsGlobalCoordinatesItems

- `x` (double, required)
- `y` (double, required)
- `z` (double, optional)

### CalibrationSensorsItemsTranslationToGlobalCoordinates

- `x` (double, required)
- `y` (double, required)
- `z` (double, optional)

### CalibrationSensorsItemsGroup

- `name` (string, required)
- `type` (string, required)
- `origin` (list of double, required)
- `dimensions` (list of double, required)
- `alias` (string, optional)

### CalibrationSensorsItemsRegion

- `placeLevel` (string, required)
- `origin` (list of double, required)
- `dimensions` (CalibrationSensorsItemsRegionDimensions, required)

### CalibrationSensorsItemsRoisItems

- `id` (string, required)
- `roiCoordinates` (list of CalibrationSensorsItemsRoisItemsRoiCoordinatesItems, required)
- `type` (string, optional)
- `restrictedObjectTypes` (list of string, optional)
- `confinedObjectTypes` (list of string, optional)

### CalibrationSensorsItemsTripwiresItems

- `id` (string, required)
- `wire` (CalibrationSensorsItemsTripwiresItemsWire, required)
- `direction` (CalibrationSensorsItemsTripwiresItemsDirection, required)

### CalibrationRoisItemsRoiCoordinatesItems

- `x` (double, required)
- `y` (double, required)
- `z` (double, optional)

### CalibrationTripwiresItemsWire

- `p1` (CalibrationTripwiresItemsWireP1, required)
- `p2` (CalibrationTripwiresItemsWireP2, required)

### CalibrationTripwiresItemsDirection

- `p1` (CalibrationTripwiresItemsDirectionP1, required)
- `p2` (CalibrationTripwiresItemsDirectionP2, required)

### CalibrationSensorsItemsRegionDimensions

- `length` (double, required)
- `width` (double, required)

### CalibrationSensorsItemsRoisItemsRoiCoordinatesItems

- `x` (double, required)
- `y` (double, required)
- `z` (double, optional)

### CalibrationSensorsItemsTripwiresItemsWire

- `p1` (CalibrationSensorsItemsTripwiresItemsWireP1, required)
- `p2` (CalibrationSensorsItemsTripwiresItemsWireP2, required)

### CalibrationSensorsItemsTripwiresItemsDirection

- `p1` (CalibrationSensorsItemsTripwiresItemsDirectionP1, required)
- `p2` (CalibrationSensorsItemsTripwiresItemsDirectionP2, required)

### CalibrationTripwiresItemsWireP1

- `x` (double, required)
- `y` (double, required)

### CalibrationTripwiresItemsWireP2

- `x` (double, required)
- `y` (double, required)

### CalibrationTripwiresItemsDirectionP1

- `x` (double, required)
- `y` (double, required)

### CalibrationTripwiresItemsDirectionP2

- `x` (double, required)
- `y` (double, required)

### CalibrationSensorsItemsTripwiresItemsWireP1

- `x` (double, required)
- `y` (double, required)

### CalibrationSensorsItemsTripwiresItemsWireP2

- `x` (double, required)
- `y` (double, required)

### CalibrationSensorsItemsTripwiresItemsDirectionP1

- `x` (double, required)
- `y` (double, required)

### CalibrationSensorsItemsTripwiresItemsDirectionP2

- `x` (double, required)
- `y` (double, required)

## Examples

**Response**

```json
{
  "version": "v1",
  "osmURL": "URL",
  "calibrationType": "cartesian",
  "sensors": [
    {
      "type": "camera",
      "id": "cam1",
      "origin": {
        "lat": 0,
        "lng": 0
      },
      "geoLocation": {
        "lat": 0,
        "lng": 0
      },
      "coordinates": {
        "x": 1,
        "y": 1,
        "z": 1
      },
      "scaleFactor": 1,
      "attributes": [
        {
          "name": "source",
          "value": "vst"
        }
      ],
      "place": [
        {
          "name": "building",
          "value": "warehouse"
        }
      ],
      "imageCoordinates": [
        {
          "x": 1,
          "y": 1
        }
      ],
      "globalCoordinates": [
        {
          "x": 1,
          "y": 1,
          "z": 1
        }
      ],
      "translationToGlobalCoordinates": {
        "x": 1,
        "y": 1,
        "z": 1
      },
      "group": {
        "name": "bev-sensor-1",
        "type": "bev",
        "origin": [
          1
        ],
        "dimensions": [
          1
        ],
        "alias": "area-1"
      },
      "region": {
        "placeLevel": "building",
        "origin": [
          1
        ],
        "dimensions": {
          "length": 1,
          "width": 1
        }
      },
      "intrinsicMatrix": [
        [
          2
        ]
      ],
      "extrinsicMatrix": [
        [
          3
        ]
      ],
      "cameraMatrix": [
        [
          4
        ]
      ],
      "homography": [
        [
          5
        ]
      ],
      "rois": [
        {
          "id": "buffer_zone_1",
          "roiCoordinates": [
            {
              "x": 1,
              "y": 1,
              "z": 0
            }
          ],
          "type": "buffer_zone",
          "restrictedObjectTypes": [
            "Person"
          ],
          "confinedObjectTypes": [
            "Fourier_GR1_T2_Humanoid"
          ]
        }
      ],
      "tripwires": [
        {
          "id": "tripwire-id-1",
          "wire": {
            "p1": {
              "x": 1,
              "y": 1
            },
            "p2": {
              "x": 1,
              "y": 1
            }
          },
          "direction": {
            "p1": {
              "x": 1,
              "y": 1
            },
            "p2": {
              "x": 1,
              "y": 1
            }
          }
        }
      ]
    }
  ],
  "rois": [
    {
      "id": "buffer_zone_1",
      "roiCoordinates": [
        {
          "x": 1,
          "y": 1,
          "z": 0
        }
      ],
      "sensors": [
        "cam1"
      ],
      "groups": [
        "bev-sensor-1"
      ],
      "type": "buffer_zone",
      "restrictedObjectTypes": [
        "Person"
      ],
      "confinedObjectTypes": [
        "Fourier_GR1_T2_Humanoid"
      ]
    }
  ],
  "tripwires": [
    {
      "id": "tripwire-id-1",
      "wire": {
        "p1": {
          "x": 1,
          "y": 1
        },
        "p2": {
          "x": 1,
          "y": 1
        }
      },
      "direction": {
        "p1": {
          "x": 1,
          "y": 1
        },
        "p2": {
          "x": 1,
          "y": 1
        }
      },
      "sensors": [
        "cam1"
      ],
      "groups": [
        "bev-sensor-1"
      ]
    }
  ],
  "corridors": [
    {
      "name": "city=abc/corridor=xyz",
      "sensors": [
        "cam1"
      ],
      "directions": [
        "N"
      ],
      "length": 5
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://ai.nvidia.com/api/v3.3/analytics/config/calibration"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://ai.nvidia.com/api/v3.3/analytics/config/calibration';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ai.nvidia.com/api/v3.3/analytics/config/calibration"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://ai.nvidia.com/api/v3.3/analytics/config/calibration")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://ai.nvidia.com/api/v3.3/analytics/config/calibration")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://ai.nvidia.com/api/v3.3/analytics/config/calibration');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://ai.nvidia.com/api/v3.3/analytics/config/calibration");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://ai.nvidia.com/api/v3.3/analytics/config/calibration")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```