1 of 14

OrganizationCreateProject

List transformation jobs

Start transformation job

Get transformation job status

Update transformation job

Delete transformation job

Retry failed transform jobs

Clear failed transform jobs

Retry transformation upload job

Delete create project file

Retry transformation file

Upload a custom block

Create new empty project

Add a collaborator to a project within an organisation

List transformation jobs

Get list of transformation jobs.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project

Path parameters

organizationId*integer

Organization ID

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

includePipelineJobsboolean

If enabled, also includes jobs that are part of a pipeline

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

totalJobCount*integer

jobs*array of object

id*integer

organizationIdinteger

name*string

uploadType*enum

datasetproject

transformJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobIdinteger

uploadJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

projectOwnerstring

projectIdinteger

projectNamestring

transformationBlockIdinteger

builtinTransformationBlockobject

transformationBlockNamestring

transformationOperatesOnTransformationJobOperatesOnEnum (enum)

filedirectorystandalone

created*string (date-time)

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

totalDownloadFileCount*integer

totalDownloadFileSize*integer

totalDownloadFileSizeString*string

totalUploadFileCountinteger

totalTimeSpentSecondsinteger

Total amount of compute used for this job (in seconds)

totalTimeSpentString*string

Total amount of compute used (friendly string)

createdByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

Request

Response

Delete transformation job

Remove a transformation job. This will stop all running jobs.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Delete transformation job

Remove a transformation job. This will stop all running jobs.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

List transformation jobs

Get list of transformation jobs.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project

Path parameters

organizationId*integer

Organization ID

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

includePipelineJobsboolean

If enabled, also includes jobs that are part of a pipeline

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

totalJobCount*integer

jobs*array of object

id*integer

organizationIdinteger

name*string

uploadType*enum

datasetproject

transformJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobIdinteger

uploadJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

projectOwnerstring

projectIdinteger

projectNamestring

transformationBlockIdinteger

builtinTransformationBlockobject

transformationBlockNamestring

transformationOperatesOnTransformationJobOperatesOnEnum (enum)

filedirectorystandalone

created*string (date-time)

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

totalDownloadFileCount*integer

totalDownloadFileSize*integer

totalDownloadFileSizeString*string

totalUploadFileCountinteger

totalTimeSpentSecondsinteger

Total amount of compute used for this job (in seconds)

totalTimeSpentString*string

Total amount of compute used (friendly string)

createdByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

Request

Response

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "success": false,
  "error": "text",
  "totalJobCount": 0,
  "jobs": [
    {
      "id": 0,
      "organizationId": 0,
      "name": "text",
      "uploadType": "dataset",
      "transformJobStatus": "waiting",
      "uploadJobId": 0,
      "uploadJobStatus": "waiting",
      "projectOwner": "text",
      "projectId": 0,
      "projectName": "text",
      "transformationBlockId": 0,
      "transformationBlockName": "text",
      "transformationOperatesOn": "file",
      "created": "2024-12-03T17:33:15.469Z",
      "outputDatasetName": "text",
      "outputDatasetBucketId": 0,
      "outputDatasetBucketPath": "text",
      "totalDownloadFileCount": 0,
      "totalDownloadFileSize": 0,
      "totalDownloadFileSizeString": "text",
      "totalUploadFileCount": 0,
      "totalTimeSpentSeconds": 0,
      "totalTimeSpentString": "text",
      "createdByUser": {
        "id": 0,
        "name": "text",
        "username": "text",
        "photo": "text"
      }
    }
  ]
}

Get transformation job status

Get the current status of a transformation job job.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

Query parameters

transformLimit*integer

Maximum number of results of transformation jobs

transformOffset*integer

Offset in results of transformation jobs, can be used in conjunction with TransformLimitResultsParameter to implement paging.

selectionstring

Type of selected rows, either 'all', 'created', 'in-progress' or 'failed' (defaults to 'all')

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

statusOrganizationCreateProjectWithFiles (all of)

id*integer

organizationId*integer

name*string

uploadType*enum

datasetproject

status*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

transformJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobIdinteger

uploadJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobFilesUploadedinteger

projectOwnerstring

projectIdinteger

projectNamestring

transformationBlockIdinteger

builtinTransformationBlockobject

transformationBlockNamestring

category*enum

trainingtestingsplit

created*string (date-time)

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

totalDownloadFileCount*integer

totalDownloadFileSize*integer

totalDownloadFileSizeString*string

totalUploadFileCount*integer

transformationParallel*integer

Number of transformation jobs that can be ran in parallel

transformationSummary*object

startedCount*integer

succeededCount*integer

finishedCount*integer

totalFileCount*integer

totalTimeSpentSeconds*integer

Total amount of compute used for this job (in seconds)

inProgress*boolean

labelstring

filterQuerystring

emailRecipientUidsarray of integer

itemsinteger

pipelineIdinteger

pipelineNamestring

pipelineRunIdinteger

pipelineStepinteger

operatesOn*TransformationJobOperatesOnEnum (enum)

filedirectorystandalone

totalTimeSpentSeconds*integer

Total amount of compute used for this job (in seconds)

totalTimeSpentString*string

Total amount of compute used (friendly string)

createdByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

files*array of object

id*integer

fileName*string

bucketPath*string

transformationJobIdinteger

transformationJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

linkToDataItem*string

lengthString*string

Only set after job was finished

sourceDatasetType*OrganizationDatasetTypeEnum (enum)

clinicalfiles

fileCountForFilter*integer

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}?transformLimit=0&transformOffset=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "status": {
    "id": 0,
    "organizationId": 0,
    "name": "text",
    "uploadType": "dataset",
    "status": "waiting",
    "transformJobStatus": "waiting",
    "uploadJobId": 0,
    "uploadJobStatus": "waiting",
    "uploadJobFilesUploaded": 0,
    "projectOwner": "text",
    "projectId": 0,
    "projectName": "text",
    "transformationBlockId": 0,
    "transformationBlockName": "text",
    "category": "training",
    "created": "2024-12-03T17:33:15.498Z",
    "outputDatasetName": "text",
    "outputDatasetBucketId": 0,
    "outputDatasetBucketPath": "text",
    "totalDownloadFileCount": 0,
    "totalDownloadFileSize": 0,
    "totalDownloadFileSizeString": "text",
    "totalUploadFileCount": 0,
    "transformationParallel": 0,
    "transformationSummary": {
      "startedCount": 0,
      "succeededCount": 0,
      "finishedCount": 0,
      "totalFileCount": 0,
      "totalTimeSpentSeconds": 0
    },
    "inProgress": false,
    "label": "text",
    "filterQuery": "text",
    "emailRecipientUids": [
      0
    ],
    "pipelineId": 0,
    "pipelineName": "text",
    "pipelineRunId": 0,
    "pipelineStep": 0,
    "operatesOn": "file",
    "totalTimeSpentSeconds": 0,
    "totalTimeSpentString": "text",
    "createdByUser": {
      "id": 0,
      "name": "text",
      "username": "text",
      "photo": "text"
    },
    "files": [
      {
        "id": 0,
        "fileName": "text",
        "bucketPath": "text",
        "transformationJobId": 0,
        "transformationJobStatus": "waiting",
        "linkToDataItem": "text",
        "lengthString": "text",
        "sourceDatasetType": "clinical"
      }
    ],
    "fileCountForFilter": 0
  }
}

Retry transformation upload job

Retry the upload job from a transformation job. Only jobs that have failed can be retried.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/upload/retry

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/upload/retry', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Clear failed transform jobs

Clear all failed transform job from a create project job. Only jobs that have failed will be cleared.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/transform/clear

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/transform/clear', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Retry failed transform jobs

Retry all failed transform job from a transformation job. Only jobs that have failed will be retried.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/transform/retry

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/transform/retry', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Start transformation job

Start a transformation job to fetch data from the organization and put it in a project, or transform into new data.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project

Path parameters

organizationId*integer

Organization ID

Body

name*string

filterstring

Filter in SQL format, used for creating transformation jobs on clinical datasets

pathFiltersarray of OrganizationCreateProjectPathFilter (object)

Set of paths to apply the transformation to, used for creating transformation jobs on default datasets. This option is experimental and may change in the future.

dataset*string

Dataset name of files to transform

filter*string

Path filter with wildcards, relative to the root of the dataset. For example, /folder/*.json will transform all JSON files in /folder (when operating on files)

uploadTypeenum

projectdataset

projectIdinteger

projectVisibilityProjectVisibility (enum)

The visibility of the project, either public or private. Public projects can be viewed by anyone on the internet and edited by collaborators. Private projects can only be viewed and edited by collaborators.

publicprivate

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

categoryenum

trainingtestingsplit

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

Path of new dataset within the bucket; used only when creating a new dataset.

outputPathInDatasetstring

Path within the selected dataset to upload transformed files into. Used only when uploading into a default (non-clinical) dataset.

outputDatasetPathRuleOrganizationCreateProjectOutputDatasetPathRule (enum)

Defines the folder structure for writing to the output dataset. Used only when uploading into a default (non-clinical) dataset.

no-subfolderssubfolder-per-itemuse-full-path

labelstring

emailRecipientUidsarray of integer

itemsinteger

transformationParallelinteger

Number of parallel jobs to start

extraCliArgumentsstring

Optional extra arguments for this transformation block

parametersobject

List of custom parameters for this transformation job (see the list of parameters that the block exposes).

Other propertiesstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

createProjectId*integer

Project ID for the new project

apiKey*string

API key for the new project

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "createProjectId": 0,
  "apiKey": "text"
}

Create new empty project

Create a new empty project within an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/new-project

Path parameters

organizationId*integer

Organization ID

Body

projectName*string

The name of the project.

Example: "EEG trials"

projectVisibilityProjectVisibility (enum)

publicprivate

projectOwnerUsernameOrEmailstring

The username or email of the owner of the project. This field is mandatory when authenticating via API key. If no email is provided when authenticating via JWT, the user ID attached to the JWT will be user as project owner.

Example: "jan@edgeimpulse.com"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Project ID for the new project

apiKey*string

API key for the new project

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/new-project', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "projectName": "EEG trials"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "id": 0,
  "apiKey": "text"
}

Retry transformation file

Retry a transformation action on a file from a transformation job. Only files that have failed can be retried.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/files/{createProjectFileId}/retry

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

createProjectFileId*integer

Create project job file ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/files/{createProjectFileId}/retry', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Retry failed transform jobs

Retry all failed transform job from a transformation job. Only jobs that have failed will be retried.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/transform/retry

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/transform/retry', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Clear failed transform jobs

Clear all failed transform job from a create project job. Only jobs that have failed will be cleared.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/transform/clear

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/transform/clear', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Retry transformation file

Retry a transformation action on a file from a transformation job. Only files that have failed can be retried.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/files/{createProjectFileId}/retry

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

createProjectFileId*integer

Create project job file ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/files/{createProjectFileId}/retry', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Retry transformation upload job

Retry the upload job from a transformation job. Only jobs that have failed can be retried.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/upload/retry

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/upload/retry', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Create new empty project

Create a new empty project within an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/new-project

Path parameters

organizationId*integer

Organization ID

Body

projectName*string

The name of the project.

Example: "EEG trials"

projectVisibilityProjectVisibility (enum)

publicprivate

projectOwnerUsernameOrEmailstring

Example: "jan@edgeimpulse.com"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Project ID for the new project

apiKey*string

API key for the new project

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/new-project', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "projectName": "EEG trials"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "id": 0,
  "apiKey": "text"
}

Start transformation job

Start a transformation job to fetch data from the organization and put it in a project, or transform into new data.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project

Path parameters

organizationId*integer

Organization ID

Body

name*string

filterstring

Filter in SQL format, used for creating transformation jobs on clinical datasets

pathFiltersarray of OrganizationCreateProjectPathFilter (object)

Set of paths to apply the transformation to, used for creating transformation jobs on default datasets. This option is experimental and may change in the future.

dataset*string

Dataset name of files to transform

filter*string

Path filter with wildcards, relative to the root of the dataset. For example, /folder/*.json will transform all JSON files in /folder (when operating on files)

uploadTypeenum

projectdataset

projectIdinteger

projectVisibilityProjectVisibility (enum)

publicprivate

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

categoryenum

trainingtestingsplit

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

Path of new dataset within the bucket; used only when creating a new dataset.

outputPathInDatasetstring

Path within the selected dataset to upload transformed files into. Used only when uploading into a default (non-clinical) dataset.

outputDatasetPathRuleOrganizationCreateProjectOutputDatasetPathRule (enum)

Defines the folder structure for writing to the output dataset. Used only when uploading into a default (non-clinical) dataset.

no-subfolderssubfolder-per-itemuse-full-path

labelstring

emailRecipientUidsarray of integer

itemsinteger

transformationParallelinteger

Number of parallel jobs to start

extraCliArgumentsstring

Optional extra arguments for this transformation block

parametersobject

List of custom parameters for this transformation job (see the list of parameters that the block exposes).

Other propertiesstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

createProjectId*integer

Project ID for the new project

apiKey*string

API key for the new project

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "createProjectId": 0,
  "apiKey": "text"
}

Get transformation job status

Get the current status of a transformation job job.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

Query parameters

transformLimit*integer

Maximum number of results of transformation jobs

transformOffset*integer

Offset in results of transformation jobs, can be used in conjunction with TransformLimitResultsParameter to implement paging.

selectionstring

Type of selected rows, either 'all', 'created', 'in-progress' or 'failed' (defaults to 'all')

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

statusOrganizationCreateProjectWithFiles (all of)

id*integer

organizationId*integer

name*string

uploadType*enum

datasetproject

status*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

transformJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobIdinteger

uploadJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobFilesUploadedinteger

projectOwnerstring

projectIdinteger

projectNamestring

transformationBlockIdinteger

builtinTransformationBlockobject

transformationBlockNamestring

category*enum

trainingtestingsplit

created*string (date-time)

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

totalDownloadFileCount*integer

totalDownloadFileSize*integer

totalDownloadFileSizeString*string

totalUploadFileCount*integer

transformationParallel*integer

Number of transformation jobs that can be ran in parallel

transformationSummary*object

startedCount*integer

succeededCount*integer

finishedCount*integer

totalFileCount*integer

totalTimeSpentSeconds*integer

Total amount of compute used for this job (in seconds)

inProgress*boolean

labelstring

filterQuerystring

emailRecipientUidsarray of integer

itemsinteger

pipelineIdinteger

pipelineNamestring

pipelineRunIdinteger

pipelineStepinteger

operatesOn*TransformationJobOperatesOnEnum (enum)

filedirectorystandalone

totalTimeSpentSeconds*integer

Total amount of compute used for this job (in seconds)

totalTimeSpentString*string

Total amount of compute used (friendly string)

createdByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

files*array of object

id*integer

fileName*string

bucketPath*string

transformationJobIdinteger

transformationJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

linkToDataItem*string

lengthString*string

Only set after job was finished

sourceDatasetType*OrganizationDatasetTypeEnum (enum)

clinicalfiles

fileCountForFilter*integer

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}?transformLimit=0&transformOffset=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "status": {
    "id": 0,
    "organizationId": 0,
    "name": "text",
    "uploadType": "dataset",
    "status": "waiting",
    "transformJobStatus": "waiting",
    "uploadJobId": 0,
    "uploadJobStatus": "waiting",
    "uploadJobFilesUploaded": 0,
    "projectOwner": "text",
    "projectId": 0,
    "projectName": "text",
    "transformationBlockId": 0,
    "transformationBlockName": "text",
    "category": "training",
    "created": "2024-12-03T17:33:15.498Z",
    "outputDatasetName": "text",
    "outputDatasetBucketId": 0,
    "outputDatasetBucketPath": "text",
    "totalDownloadFileCount": 0,
    "totalDownloadFileSize": 0,
    "totalDownloadFileSizeString": "text",
    "totalUploadFileCount": 0,
    "transformationParallel": 0,
    "transformationSummary": {
      "startedCount": 0,
      "succeededCount": 0,
      "finishedCount": 0,
      "totalFileCount": 0,
      "totalTimeSpentSeconds": 0
    },
    "inProgress": false,
    "label": "text",
    "filterQuery": "text",
    "emailRecipientUids": [
      0
    ],
    "pipelineId": 0,
    "pipelineName": "text",
    "pipelineRunId": 0,
    "pipelineStep": 0,
    "operatesOn": "file",
    "totalTimeSpentSeconds": 0,
    "totalTimeSpentString": "text",
    "createdByUser": {
      "id": 0,
      "name": "text",
      "username": "text",
      "photo": "text"
    },
    "files": [
      {
        "id": 0,
        "fileName": "text",
        "bucketPath": "text",
        "transformationJobId": 0,
        "transformationJobStatus": "waiting",
        "linkToDataItem": "text",
        "lengthString": "text",
        "sourceDatasetType": "clinical"
      }
    ],
    "fileCountForFilter": 0
  }
}

Update transformation job

Update the properties of a transformation job.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

Body

transformationParallelinteger

Number of transformation jobs that can be ran in parallel

emailRecipientUidsarray of integer

List of user IDs to notify when a Job succeeds

itemsinteger

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Upload a custom block

Upload a zip file containing a custom transformation or deployment block.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/custom-block

Path parameters

organizationId*integer

Organization ID

Body

tar*string (binary)

type*enum

transformdeploydsptransferLearning

blockId*integer

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

Add a collaborator to a project within an organisation

Add a new collaborator to a project owned by an organisation.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/add-project-collaborator

Path parameters

organizationId*integer

Organization ID

Body

projectId*integer

The ID of the project to add the collaborator to.

userId*integer

The user ID to add to the project. The user must be an admin of the organization.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Delete create project file

Remove a file from a create project job. Only files for which no jobs are running can be deleted.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/files/{createProjectFileId}

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

createProjectFileId*integer

Create project job file ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Delete create project file

Remove a file from a create project job. Only files for which no jobs are running can be deleted.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/files/{createProjectFileId}

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

createProjectFileId*integer

Create project job file ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Add a collaborator to a project within an organisation

Add a new collaborator to a project owned by an organisation.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/add-project-collaborator

Path parameters

organizationId*integer

Organization ID

Body

projectId*integer

The ID of the project to add the collaborator to.

userId*integer

The user ID to add to the project. The user must be an admin of the organization.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Update transformation job

Update the properties of a transformation job.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}

Path parameters

organizationId*integer

Organization ID

createProjectId*integer

Create project job ID.

Body

transformationParallelinteger

Number of transformation jobs that can be ran in parallel

emailRecipientUidsarray of integer

List of user IDs to notify when a Job succeeds

itemsinteger

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Upload a custom block

Upload a zip file containing a custom transformation or deployment block.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/custom-block

Path parameters

organizationId*integer

Organization ID

Body

tar*string (binary)

type*enum

transformdeploydsptransferLearning

blockId*integer

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}/files/{createProjectFileId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/add-project-collaborator', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "projectId": 0,
      "userId": 0
    }),
});
const data = await response.json();

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/custom-block', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "tar": "binary",
      "type": "transform",
      "blockId": 0
    }),
});
const data = await response.json();