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

# Get status

`GET /api/{projectId}/performance-calibration/status`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/{projectId}/performance-calibration/status`
- 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/status/get.ts> (a function with typed inputs; its response is checked against the schema)

Get performance calibration status

## Path parameters

- `projectId` integer, required

## Query parameters

- `impulseId` integer

## Response `200`

OK

- GetPerformanceCalibrationStatusResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `available` boolean, required
  - `unsupportedProjectError` string: If the current project is unsupported by performance calibration, this field explains the reason why. Otherwise, it is undefined.
  - `options` StartPerformanceCalibrationRequest
    - `backgroundNoiseLabel` string, required: The label used to signify background noise in the impulse
    - `otherNoiseLabels` string[]: Any other labels that should be considered equivalent to background noise
    - `uploadKey` string: The key of an uploaded sample. If not present, a synthetic sample will be created.
    - `sampleLengthMinutes` number: The length of sample to create (required for synthetic samples)

---

[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)