Skip to main content

KeyV2

Musical key prediction. Provides track-level key detection and segment-level key tags over time, along with confidence scores.

versionVersionrequired
Constant value: KeyV2
Default value: KeyV2
segments objectrequired

Segment-level key tags.

timestampsSecondsnumber[]required

Possible values: >= 0

valuesKeyV2Tags[]required

Possible values: [aMajor, aMinor, bMajor, bMinor, bFlatMajor, bFlatMinor, cMajor, cMinor, dFlatMajor, cSharpMinor, dMajor, dMinor, eFlatMajor, dSharpMinor, eMajor, eMinor, fMajor, fMinor, fSharpMajor, fSharpMinor, gMajor, gMinor, aFlatMajor, gSharpMinor]

tagKeyV2Tagsrequired

Track-level key tags.

Possible values: [aMajor, aMinor, bMajor, bMinor, bFlatMajor, bFlatMinor, cMajor, cMinor, dFlatMajor, cSharpMinor, dMajor, dMinor, eFlatMajor, dSharpMinor, eMajor, eMinor, fMajor, fMinor, fSharpMajor, fSharpMinor, gMajor, gMinor, aFlatMajor, gSharpMinor]

confidences objectrequired

A structured confidence object with three values in 0.0-1.0:

  • modelCertainty: how sure the model is that the prediction is correct
  • predictionStability: how stable the prediction is across segments
  • confidence: an overall confidence score, the minimum of the two individual scores
modelCertaintyModel Certaintyrequired

Possible values: >= 0 and <= 1

predictionStabilityPrediction Stabilityrequired

Possible values: >= 0 and <= 1

confidenceConfidencerequired

Possible values: >= 0 and <= 1

KeyV2
{
"version": "KeyV2",
"segments": {
"timestampsSeconds": [
0
],
"values": [
"aMajor"
]
},
"tag": "aMajor",
"confidences": {
"modelCertainty": 0,
"predictionStability": 0,
"confidence": 0
}
}