Skip to main content
PUT
/
analyse.compute_keyword_similarities
analyse.compute_keyword_similarities
curl --request PUT \
  --url https://api.soundpiece.co/analyse.compute_keyword_similarities \
  --header 'Content-Type: application/json' \
  --data '
{
  "audio": {
    "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "keywords": [
    "<string>"
  ],
  "comparison_type": "music",
  "callback": {
    "url": "<string>",
    "context": {}
  }
}
'
{
  "computation": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "generating",
    "similarities": {
      "keywords": [
        "<string>"
      ],
      "comparison_type": "<string>",
      "values": {}
    }
  }
}

Body

application/json
audio
AssetSource · object
required

The audio source to compute keyword similarities for

keywords
string[]
required

The keywords to analyze

comparison_type
enum<string>
required

The type of comparison to perform

Available options:
music,
drums,
fx
callback
Callback · object

Configuration for a callback that will be called when the computation is complete

Response

Successful Response

computation
KeywordSimilaritiesComputation · object
required

A computation to track the keyword similarity computation