POST
/
api
/
organizations
/
{organizationId}
/
create-project
Start transformation job
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "filter": "<string>",
  "pathFilters": [
    {
      "dataset": "<string>",
      "filter": "<string>"
    }
  ],
  "uploadType": "project",
  "projectId": 123,
  "projectVisibility": "public",
  "newProjectName": "<string>",
  "projectApiKey": "<string>",
  "projectHmacKey": "<string>",
  "transformationBlockId": 123,
  "builtinTransformationBlock": {},
  "category": "training",
  "outputDatasetName": "<string>",
  "outputDatasetBucketId": 123,
  "outputDatasetBucketPath": "<string>",
  "outputPathInDataset": "<string>",
  "outputDatasetPathRule": "no-subfolders",
  "label": "<string>",
  "emailRecipientUids": [
    123
  ],
  "transformationParallel": 123,
  "extraCliArguments": "<string>",
  "parameters": {}
}'
{
  "success": true,
  "error": "<string>",
  "createProjectId": 123,
  "apiKey": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
organizationId
integer
required

Organization ID

Body

application/json

If uploadType is set to 'project', either projectId, newProjectName or both projectApiKey and projectHmacKey are required. projectId and newProjectName are only available through JWT tokens. If uploadType is set to 'dataset' then outputDatasetName can be set to '' to output in the same dataset, or set to a string to create (or append to) a new dataset.

​
name
string
required
​
filter
string

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

​
pathFilters
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.

​
uploadType
enum<string>
Available options:
project,
dataset
​
projectId
integer
​
projectVisibility
enum<string>

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.

Available options:
public,
private
​
newProjectName
string
​
projectApiKey
string
​
projectHmacKey
string
​
transformationBlockId
integer
​
builtinTransformationBlock
object
​
category
enum<string>
Available options:
training,
testing,
split
​
outputDatasetName
string
​
outputDatasetBucketId
integer
​
outputDatasetBucketPath
string

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

​
outputPathInDataset
string

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

​
outputDatasetPathRule
enum<string>

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

Available options:
no-subfolders,
subfolder-per-item,
use-full-path
​
label
string
​
emailRecipientUids
integer[]
​
transformationParallel
integer

Number of parallel jobs to start

​
extraCliArguments
string

Optional extra arguments for this transformation block

​
parameters
object

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

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
createProjectId
integer
required

Project ID for the new project

​
apiKey
string
required

API key for the new project

​
error
string

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