Skip to main content
GET
/
api
/
{projectId}
/
pretrained-model
Get pretrained model
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/pretrained-model \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "specificDeviceSelected": true,
  "availableModelTypes": [
    "int8"
  ],
  "error": "<string>",
  "model": {
    "fileName": "<string>",
    "inputs": [
      {
        "dataType": "int8",
        "name": "<string>",
        "shape": [
          123
        ],
        "quantizationScale": 123,
        "quantizationZeroPoint": 123
      }
    ],
    "outputs": [
      {
        "dataType": "int8",
        "name": "<string>",
        "shape": [
          123
        ],
        "quantizationScale": 123,
        "quantizationZeroPoint": 123
      }
    ],
    "profileInfo": {
      "table": {
        "variant": "int8",
        "lowEndMcu": {
          "description": "<string>",
          "supported": true,
          "timePerInferenceMs": 123,
          "memory": {
            "tflite": {
              "ram": 123,
              "rom": 123
            },
            "eon": {
              "ram": 123,
              "rom": 123
            },
            "eonRamOptimized": {
              "ram": 123,
              "rom": 123
            }
          },
          "mcuSupportError": "<string>"
        },
        "highEndMcu": {
          "description": "<string>",
          "supported": true,
          "timePerInferenceMs": 123,
          "memory": {
            "tflite": {
              "ram": 123,
              "rom": 123
            },
            "eon": {
              "ram": 123,
              "rom": 123
            },
            "eonRamOptimized": {
              "ram": 123,
              "rom": 123
            }
          },
          "mcuSupportError": "<string>"
        },
        "highEndMcuPlusAccelerator": {
          "description": "<string>",
          "supported": true,
          "timePerInferenceMs": 123,
          "memory": {
            "tflite": {
              "ram": 123,
              "rom": 123
            },
            "eon": {
              "ram": 123,
              "rom": 123
            },
            "eonRamOptimized": {
              "ram": 123,
              "rom": 123
            }
          },
          "mcuSupportError": "<string>"
        },
        "mpu": {
          "description": "<string>",
          "supported": true,
          "timePerInferenceMs": 123,
          "rom": 123
        },
        "gpuOrMpuAccelerator": {
          "description": "<string>",
          "supported": true,
          "timePerInferenceMs": 123,
          "rom": 123
        }
      },
      "float32": {
        "variant": "int8",
        "device": "<string>",
        "tfliteFileSizeBytes": 123,
        "isSupportedOnMcu": true,
        "customMetrics": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "hasPerformance": true,
        "memory": {
          "tflite": {
            "ram": 123,
            "rom": 123,
            "arenaSize": 123
          },
          "eon": {
            "ram": 123,
            "rom": 123,
            "arenaSize": 123
          },
          "eonRamOptimized": {
            "ram": 123,
            "rom": 123,
            "arenaSize": 123
          }
        },
        "timePerInferenceMs": 123,
        "mcuSupportError": "<string>",
        "profilingError": "<string>"
      },
      "int8": {
        "variant": "int8",
        "device": "<string>",
        "tfliteFileSizeBytes": 123,
        "isSupportedOnMcu": true,
        "customMetrics": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "hasPerformance": true,
        "memory": {
          "tflite": {
            "ram": 123,
            "rom": 123,
            "arenaSize": 123
          },
          "eon": {
            "ram": 123,
            "rom": 123,
            "arenaSize": 123
          },
          "eonRamOptimized": {
            "ram": 123,
            "rom": 123,
            "arenaSize": 123
          }
        },
        "timePerInferenceMs": 123,
        "mcuSupportError": "<string>",
        "profilingError": "<string>"
      }
    },
    "profileJobId": 123,
    "profileJobFailed": true,
    "supportsTFLite": true
  },
  "modelInfo": {
    "input": {
      "inputType": "time-series",
      "frequencyHz": 123,
      "windowLengthMs": 123
    },
    "model": {
      "modelType": "classification",
      "labels": [
        "<string>"
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.nordic.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
specificDeviceSelected
boolean
required

Whether a specific device was selected for performance profiling

​
availableModelTypes
enum<string>[]
required

The types of model that are available

Available options:
int8,
float32,
akida,
requiresRetrain
​
error
string

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

​
model
object
​
modelInfo
object