OrganizationCreateProject

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

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/create-project/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationIdinteger required

Organization ID

Request body

namestring required

filterstring

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

uploadType'project' | 'dataset'

projectIdinteger

projectVisibility'public' | 'private'

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.

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

category'training' | 'validation' | 'testing' | 'split'

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.

outputDatasetPathRule'no-subfolders' | 'subfolder-per-item' | 'use-full-path'

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

labelstring

emailRecipientUidsinteger[]

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

successboolean required

Whether the operation succeeded

errorstring

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

createProjectIdinteger required

Project ID for the new project

apiKeystring required

DEPRECATED. API key for the new project. This field will always be empty.

Changes

No recorded changes to this operation across all 1 revision of this API.