Start transformation job

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

application/json

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.

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

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).

Response

200

OK

Body

application/json

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

JavaScriptCurlPython

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

200

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