Profile custom DSP block

Returns performance characteristics for a custom DSP block (needs hasTfliteImplementation). Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/profile

Path parameters

projectId*integer

Project ID

dspId*integer

DSP Block ID, use the impulse functions to retrieve the ID

Body

params*object

DSP parameters with values

Other propertiesnullable string

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/profile', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "params": {
        "scale-axes": "10"
      }
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "id": 12873488112
}