Save AI Actions config
Store an AI Actions config. Use createAIActionsJob
to run the job. Post the full AI Action here w/ all parameters.
Authorizations
Path parameters
projectIdintegerRequired
Project ID
actionIdintegerRequired
AI Action ID
Body
namestringOptional
User-provided name. If no name is set then displayName on the action will be automatically configured based on the transformation block.
dataCategorystring · enumRequiredPossible values:
Type of data to run this AI action on.
dataMetadataKeystringOptional
Metadata key to filter on. Required if dataCategory is equal to "dataWithoutMetadataKey" or "dataWithMetadata".
dataMetadataValuestringOptional
Metadata value to filter on. Required if dataCategory is equal to "dataWithMetadata".
sortOrderintegerOptional
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).
Responses
200
OK
application/json
post
POST /v1/api/{projectId}/ai-actions/{actionId} HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 250
{
"name": "text",
"steps": [
{
"transformationBlockId": 1,
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"dataCategory": "allData",
"dataMetadataKey": "text",
"dataMetadataValue": "text",
"setMetadataAfterRunning": [
{
"key": "text",
"value": "text"
}
],
"sortOrder": 1
}
200
OK
{
"success": true,
"error": "text"
}
Last updated
Was this helpful?