---
title: "Get ground truth"
method: GET
path: "/api/{projectId}/performance-calibration/ground-truth"
tags: ["PerformanceCalibration"]
---

# Get ground truth

`GET /api/{projectId}/performance-calibration/ground-truth`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/{projectId}/performance-calibration/ground-truth`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/performance-calibration/ground-truth/get.ts> (a function with typed inputs; its response is checked against the schema)

Get performance calibration ground truth data

## Path parameters

- `projectId` integer, required

## Query parameters

- `impulseId` integer

## Response `200`

OK

- GetPerformanceCalibrationGroundTruthResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `samples` PerformanceCalibrationGroundTruth[], required
    - `type` 'sample' | 'noise' | 'combined_noise', required: Whether this region is a single sample, a region of background noise, or a region of background noise that contains samples.
    - `labelIdx` integer, required: Index of the label in the array of all labels
    - `labelString` string, required: String label of the sample
    - `start` integer, required: The start time of the region in milliseconds
    - `length` integer, required: The length of the region in milliseconds
    - `samples` object[]: If the region contains samples, all the samples within this region
      - `id` integer, required: The ID of the samples in Studio
      - `start` number, required: The start time of the sample in milliseconds
      - `length` number, required: The length of the sample in milliseconds
      - `idx` integer, required: For debugging. The index of the sample in the original Y array.

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)