Add API key

Add API key

Add an API key. If you set developmentKey to true this flag will be removed from the current development API key.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/apikeys

Path parameters

projectId*integer

Project ID

Body

application/json

name*string

Description of the key

apiKey*string

API key. This needs to start with ei_ and will need to be at least 32 characters long.

isDevelopmentKey*boolean

Whether this key should be used as a development key.

role*enum

adminreadonlyingestiononly

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/apikeys', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "apiKey": "text",
      "isDevelopmentKey": false,
      "role": "admin"
    }),
});
const data = await response.json();

Response

200

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