---
title: "Performance Calibration"
method: POST
path: "/api/{projectId}/jobs/performance-calibration"
tags: ["Jobs"]
---

# Performance Calibration

`POST /api/{projectId}/jobs/performance-calibration`

## Request

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

Simulates real world usage and returns performance metrics.

## Path parameters

- `projectId` integer, required

## Query parameters

- `impulseId` integer

## Request body

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

## Response `200`

OK

- StartJobResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `id` integer, required: Job identifier. Status updates will include this identifier.

---

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