All pages
Powered by GitBook
1 of 43

Jobs

Jobs are long-running tasks that are executed asynchronously. Jobs are identified by their job ID, in the form of job-1569583053767, which is returned when starting a job. Subsequent job updates are published over the websockets API.

Updates

There are two events that are published regarding jobs:

  • job-data-{jobId} - status update on the job, e.g. progress when training a neural network. Provides a single argument: { data: 'string with status' }.

  • job-finished-{jobId} - indicator that the job finished. Provides a single argument: { success: true } which indicates whether the job was executed successfully.

Canceling a job

You can also cancel a job through the websocket by sending a job-cancel event. Pass in one parameter (the job ID).

Post-processing

Generate data explorer features

Retry impulse migration

Create synthetic data

Create preview AI Actions job

Create AI Actions job

Optimize model

Sets EON tuner primary model

List active jobs

List finished jobs

List all jobs

Job summary

Get impulse migration status

Get impulse migration logs

Get impulse migration logs

get

Get the logs for the multi-impulse migration job in this project. This is a separate route so public projects can access it. If no multi-impulse migration jobs are present, an error will be thrown.

Authorizations
Path parameters
projectIdintegerrequired

Project ID

Query parameters
limitintegeroptional

Maximum number of results

logLevelstring · enumoptional

Log level (error, warn, info, debug)

Options: error, warn, info, debug
Responses
curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/impulse-migration/stdout' \
  --header 'x-api-key: YOUR_API_KEY'
{
  "success": true,
  "error": "text",
  "stdout": [
    {
      "created": "2025-03-30T12:48:36.356Z",
      "data": "text",
      "logLevel": "error"
    }
  ],
  "totalCount": 1
}

OK

Update job

Get job status

Get job status

get

Get the status for a job.

Authorizations
Path parameters
projectIdintegerrequired

Project ID

jobIdintegerrequired

Job ID

Responses
curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/{jobId}/status' \
  --header 'x-api-key: YOUR_API_KEY'
{
  "success": true,
  "error": "text",
  "job": {
    "id": 1,
    "category": "text",
    "key": "text",
    "created": "2025-03-30T12:48:36.356Z",
    "started": "2025-03-30T12:48:36.356Z",
    "finished": "2025-03-30T12:48:36.356Z",
    "finishedSuccessful": true,
    "jobNotificationUids": [
      1
    ],
    "additionalInfo": "text",
    "computeTime": 1,
    "createdByUser": {
      "id": 1,
      "name": "text",
      "username": "text",
      "photo": "text"
    },
    "categoryCount": 1
  }
}

OK

Get logs

Get logs

get

Get the logs for a job.

Authorizations
Path parameters
projectIdintegerrequired

Project ID

jobIdintegerrequired

Job ID

Query parameters
limitintegeroptional

Maximum number of results

logLevelstring · enumoptional

Log level (error, warn, info, debug)

Options: error, warn, info, debug
Responses
curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/{jobId}/stdout' \
  --header 'x-api-key: YOUR_API_KEY'
{
  "success": true,
  "error": "text",
  "stdout": [
    {
      "created": "2025-03-30T12:48:36.356Z",
      "data": "text",
      "logLevel": "error"
    }
  ],
  "totalCount": 1
}

OK

Download logs

Download logs

get

Download the logs for a job (as a text file).

Authorizations
Path parameters
projectIdintegerrequired

Project ID

jobIdintegerrequired

Job ID

Query parameters
limitintegeroptional

Maximum number of results

logLevelstring · enumoptional

Log level (error, warn, info, debug)

Options: error, warn, info, debug
Responses
curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/{jobId}/stdout/download' \
  --header 'x-api-key: YOUR_API_KEY'
text

OK

Cancel job

Generate features

Autotune DSP parameters

Train model (Keras)

Train model (Anomaly)

Export Keras block

Export Keras block

post

Export the training pipeline of a Keras block. Updates are streamed over the websocket API.

Authorizations
Path parameters
projectIdintegerrequired

Project ID

learnIdintegerrequired

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

Responses
curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/train/keras/{learnId}/export' \
  --header 'x-api-key: YOUR_API_KEY'
{
  "success": true,
  "error": "text",
  "id": 12873488112
}

OK

Export Keras block data

Build on-device model

Build organizational on-device model

Export original data

Export data as WAV

Retrain

Classify

Performance Calibration

Evaluate

Version project

Restore project to version

Restore project to public version

Make a version public

Add keywords and noise

Profile TFLite model

Deploy pretrained model

Get TFLite profile result (GET)

Get TFLite profile result (POST)