Jobs

Autotune DSP parameters

Autotune DSP block parameters. Updates are streamed over the websocket API.

post/api/{projectId}/jobs/autotune-dsp

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or 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/autotune-dsp/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Request body

dspIdinteger required

DSP block ID to autotune parameters of

configobject

Optional updated DSP block config. If undefined, the current saved block config will be used. This enables experimenting with the autotuner using temporary config options, without updating the stored DSP block config.

Response

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

Job identifier. Status updates will include this identifier.

Example response

{
  "id": 12873488112
}

Changes

No recorded changes to this operation across all 1 revision of this API.