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.

post

/api/organizations/{organizationId}/create-project

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

Body

namestringrequired

filterstring

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

projectIdinteger

projectVisibilitystring · 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.

Options: public, private

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

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.

outputDatasetPathRulestring · enum

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

Options: no-subfolders, subfolder-per-item, use-full-path

labelstring

transformationParallelinteger

Number of parallel jobs to start

extraCliArgumentsstring

Optional extra arguments for this transformation block

uploadTypestring · enum

Options: project, dataset

categorystring · enum

Options: training, testing, split

pathFiltersobject[]

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.

emailRecipientUidsinteger[]

parametersobject

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","projectVisibility":"public","builtinTransformationBlock":{},"outputDatasetPathRule":"no-subfolders","uploadType":"project","category":"training","pathFilters":[{"dataset":"text","filter":"text"}],"emailRecipientUids":[null],"parameters":{}}'

200

200

{
  "success": true,
  "error": "text",
  "createProjectId": 1,
  "apiKey": "text"
}

OK