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

name*string

Description of the key

apiKeystring

Optional: API key. This needs to start with ei_ and will need to be at least 32 characters long. If this field is not passed in, a new API key is generated for you.

isDevelopmentKey*boolean

Whether this key should be used as a development key.

role*enum

adminreadonlyingestiononly

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

ID of the new API key

apiKey*string

New API Key (starts with "ei_...") - this'll be shared only once.

Request

Response

PreviousGet API keys NextRevoke API key

Last updated 8 months ago

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