Get a list of all model variants available for this project

Get a list of model variants applicable to all trained learn blocks in this project.

GET /api/{projectId}/model-variants

Try it

Get a list of all model variants available for this project

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/model-variants \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "modelVariants": [
    {
      "variant": "int8",
      "isReferenceVariant": true,
      "isEnabled": true,
      "isSelected": true
    }
  ],
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

Query Parameters

impulseId · integer

Impulse ID. If this is unset then the default impulse is used.

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

modelVariants · object[] · required

All model variants relevant for all learn blocks in the project

Show child attributes

modelVariants. variant · enum<string> · required

Available options: int8, float32, akida

modelVariants. isReferenceVariant · boolean · required

True if this model variant is the default or "reference variant" for this project

modelVariants. isEnabled · boolean · required

True if profiling for this model variant is enabled for the current project

modelVariants. isSelected · boolean · required

True if this is the selected model variant for this project, used to keep the same view after refreshing. Update this via defaultProfilingVariant in UpdateProjectRequest.

error · string

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