Projects

Save AI Actions config

Store an AI Actions config. Use createAIActionsJob to run the job. Post the full AI Action here w/ all parameters.

post/api/{projectId}/ai-actions/{actionId}

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

Path parameters

projectIdinteger required

Project ID

actionIdinteger required

AI Action ID

Request body

namestring

User-provided name. If no name is set then displayName on the action will be automatically configured based on the transformation block.

dataCategory'allData' | 'unlabeledData' | 'enabledData' | 'dataWithoutMetadataKey' | 'dataWithMetadata' required

dataMetadataKeystring

Metadata key to filter on. Required if dataCategory is equal to "dataWithoutMetadataKey" or "dataWithMetadata".

dataMetadataValuestring

Metadata value to filter on. Required if dataCategory is equal to "dataWithMetadata".

sortOrderinteger

Numeric value (1..n) where this action should be shown in the action list (and in which order the actions should run when started from a data source).

Response

successboolean required

Whether the operation succeeded

errorstring

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

Changes

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