1 of 1

Create pipeline

Create an organizational pipelines

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines

Path parameters

organizationId*integer

Organization ID

Body

name*string

description*string

intervalStrstring

15m for every 15 minutes, 2h for every 2 hours, 1d for every 1 day

steps*array of OrganizationPipelineStep (object)

name*string

filterstring

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.

dataset*string

Dataset name of files to transform

filter*string

Path filter with wildcards, relative to the root of the dataset. For example, /folder/*.json will transform all JSON files in /folder (when operating on files)

uploadTypeenum

projectdataset

projectIdinteger

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

categoryenum

trainingtestingsplit

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

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

transformationParallelinteger

extraCliArgumentsstring

parametersobject

Other propertiesstring

datasetstring

projectIdinteger

emailRecipientUids*array of integer

itemsinteger

notificationWebhookstring

whenToEmail*enum

alwayson_new_datanever

archivedboolean

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Request

Response

Create pipeline

Create an organizational pipelines

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines

Path parameters

organizationId*integer

Organization ID

Body

name*string

description*string

intervalStrstring

15m for every 15 minutes, 2h for every 2 hours, 1d for every 1 day

steps*array of OrganizationPipelineStep (object)

name*string

filterstring

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.

dataset*string

Dataset name of files to transform

filter*string

Path filter with wildcards, relative to the root of the dataset. For example, /folder/*.json will transform all JSON files in /folder (when operating on files)

uploadTypeenum

projectdataset

projectIdinteger

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

categoryenum

trainingtestingsplit

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

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

transformationParallelinteger

extraCliArgumentsstring

parametersobject

Other propertiesstring

datasetstring

projectIdinteger

emailRecipientUids*array of integer

itemsinteger

notificationWebhookstring

whenToEmail*enum

alwayson_new_datanever

archivedboolean

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Request

Response

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "description": "text",
      "steps": [
        {
          "name": "text"
        }
      ],
      "emailRecipientUids": [
        0
      ],
      "whenToEmail": "always"
    }),
});
const data = await response.json();

{
  "success": false,
  "error": "text",
  "id": 0
}