Start transformation job

Start transformation job

post

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

Body

namestringrequired

filterstringoptional

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

pathFiltersobject[]optional

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.

uploadTypestring · enumoptional

Options: project, dataset

projectIdintegeroptional

projectVisibilitystring · enumoptional

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

newProjectNamestringoptional

projectApiKeystringoptional

projectHmacKeystringoptional

transformationBlockIdintegeroptional

builtinTransformationBlockobjectoptional

categorystring · enumoptional

Options: training, testing, split

outputDatasetNamestringoptional

outputDatasetBucketIdintegeroptional

outputDatasetBucketPathstringoptional

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

outputPathInDatasetstringoptional

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

outputDatasetPathRulestring · enumoptional

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

labelstringoptional

emailRecipientUidsinteger[]optional

transformationParallelintegeroptional

Number of parallel jobs to start

extraCliArgumentsstringoptional

Optional extra arguments for this transformation block

parametersobjectoptional

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",
    "filter": "text",
    "pathFilters": [
      {
        "dataset": "text",
        "filter": "text"
      }
    ],
    "uploadType": "project",
    "projectId": 1,
    "projectVisibility": "public",
    "newProjectName": "text",
    "projectApiKey": "text",
    "projectHmacKey": "text",
    "transformationBlockId": 1,
    "builtinTransformationBlock": {},
    "category": "training",
    "outputDatasetName": "text",
    "outputDatasetBucketId": 1,
    "outputDatasetBucketPath": "text",
    "outputPathInDataset": "text",
    "outputDatasetPathRule": "no-subfolders",
    "label": "text",
    "emailRecipientUids": [
      1
    ],
    "transformationParallel": 1,
    "extraCliArguments": "text",
    "parameters": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }'

200

200

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

OK