musiccompanion. analyses
Asynchronous jobs: one job runs one analysis type against one audio source and returns a typed result.
The source is either an entity (its attached online audio) or an asset. A standalone asset works too, so you can analyse a temporary file without creating an entity:
POST /api/v1/musiccompanion/assetswith"retention": "standalone". The response carries anassetIdand a signeduploadtarget.PUTthe audio bytes toupload.urlwith the returnedupload.headers.POST /api/v1/musiccompanion/assets/{id}/confirm.POST /api/v1/musiccompanion/analyseswith{ "type": ..., "source": { "assetId": ... } }.- Poll
GET /api/v1/musiccompanion/analyses/{jobId}until it succeeds, then readresult.
Standalone assets are cleaned up automatically after a retention period and never enter your song library.
To check whether a source already has results, filter the job list: GET /api/v1/musiccompanion/analyses?entityId=... or ?assetId=... (an assetId matches jobs that requested the asset directly and jobs whose entity source resolved to it).
Start an analysis job
The source is an entity (its attached online audio) or a confirmed asset. An asset uploaded with `'retention': 'standalone'` works too, so a temporary file can be analysed without creating an entity.
List the tenant's analysis jobs
List the tenant's analysis jobs
Poll an analysis job, retrieve its result when ready
Poll an analysis job, retrieve its result when ready