Projects

Add API key

Add an API key. If you set developmentKey to true this flag will be removed from the current development API key. For OAuth-based third-party integrations, prefer /api/{projectId}/apikeys/ingestiononly.

post/api/{projectId}/apikeys

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/apikeys/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Request body

namestring required

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.

isDevelopmentKeyboolean required

Whether this key should be used as a development key.

role'admin' | 'readonly' | 'ingestiononly' | 'ingestion_deployment' required

ttlinteger

Optional: time to live in seconds.

projectExtensionIdinteger

Optional: extension ID when this API key is created for a project extension.

Response

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

ID of the new API key

apiKeystring required

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

Changes

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