Skip to main content
POST
/
api
/
{projectId}
/
jobs
/
train
/
anomaly
/
{learnId}
Train model (Anomaly)
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/train/anomaly/{learnId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "axes": [
    0,
    11,
    22
  ],
  "minimumConfidenceRating": 0.3,
  "clusterCount": 32,
  "skipEmbeddingsAndMemory": true,
  "thresholds": [
    {
      "key": "min_score",
      "description": "Score threshold",
      "helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.",
      "value": 0.5,
      "suggestedValue": 123,
      "suggestedValueText": "<string>",
      "dropdownOptions": [
        {
          "description": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}
'
import requests

url = "https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/train/anomaly/{learnId}"

payload = {
"axes": [0, 11, 22],
"minimumConfidenceRating": 0.3,
"clusterCount": 32,
"skipEmbeddingsAndMemory": True,
"thresholds": [
{
"key": "min_score",
"description": "Score threshold",
"helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.",
"value": 0.5,
"suggestedValue": 123,
"suggestedValueText": "<string>",
"dropdownOptions": [
{
"description": "<string>",
"value": "<string>"
}
]
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
axes: [0, 11, 22],
minimumConfidenceRating: 0.3,
clusterCount: 32,
skipEmbeddingsAndMemory: true,
thresholds: [
{
key: 'min_score',
description: 'Score threshold',
helpText: 'Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.',
value: 0.5,
suggestedValue: 123,
suggestedValueText: '<string>',
dropdownOptions: [{description: '<string>', value: '<string>'}]
}
]
})
};

fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/train/anomaly/{learnId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/train/anomaly/{learnId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'axes' => [
0,
11,
22
],
'minimumConfidenceRating' => 0.3,
'clusterCount' => 32,
'skipEmbeddingsAndMemory' => true,
'thresholds' => [
[
'key' => 'min_score',
'description' => 'Score threshold',
'helpText' => 'Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.',
'value' => 0.5,
'suggestedValue' => 123,
'suggestedValueText' => '<string>',
'dropdownOptions' => [
[
'description' => '<string>',
'value' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/train/anomaly/{learnId}"

payload := strings.NewReader("{\n \"axes\": [\n 0,\n 11,\n 22\n ],\n \"minimumConfidenceRating\": 0.3,\n \"clusterCount\": 32,\n \"skipEmbeddingsAndMemory\": true,\n \"thresholds\": [\n {\n \"key\": \"min_score\",\n \"description\": \"Score threshold\",\n \"helpText\": \"Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.\",\n \"value\": 0.5,\n \"suggestedValue\": 123,\n \"suggestedValueText\": \"<string>\",\n \"dropdownOptions\": [\n {\n \"description\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/train/anomaly/{learnId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"axes\": [\n 0,\n 11,\n 22\n ],\n \"minimumConfidenceRating\": 0.3,\n \"clusterCount\": 32,\n \"skipEmbeddingsAndMemory\": true,\n \"thresholds\": [\n {\n \"key\": \"min_score\",\n \"description\": \"Score threshold\",\n \"helpText\": \"Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.\",\n \"value\": 0.5,\n \"suggestedValue\": 123,\n \"suggestedValueText\": \"<string>\",\n \"dropdownOptions\": [\n {\n \"description\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/train/anomaly/{learnId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"axes\": [\n 0,\n 11,\n 22\n ],\n \"minimumConfidenceRating\": 0.3,\n \"clusterCount\": 32,\n \"skipEmbeddingsAndMemory\": true,\n \"thresholds\": [\n {\n \"key\": \"min_score\",\n \"description\": \"Score threshold\",\n \"helpText\": \"Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.\",\n \"value\": 0.5,\n \"suggestedValue\": 123,\n \"suggestedValueText\": \"<string>\",\n \"dropdownOptions\": [\n {\n \"description\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "id": 12873488112,
  "error": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

projectId
integer
required

Project ID

learnId
integer
required

Learn Block ID, use the impulse functions to retrieve the ID

Body

application/json
axes
integer[]
required

Which axes (indexes from DSP script) to include in the training set

Example:
[0, 11, 22]
minimumConfidenceRating
number
required

DEPRECATED, use "thresholds" instead. Minimum confidence rating required before tagging as anomaly

Example:

0.3

clusterCount
integer

Number of clusters for K-means, or number of components for GMM

Example:

32

skipEmbeddingsAndMemory
boolean

If set, skips creating embeddings and measuring memory (used in tests)

thresholds
object[]

List of configurable thresholds for this block.

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

id
integer
required

Job identifier. Status updates will include this identifier.

Example:

12873488112

error
string

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