Run pipeline

Run an organizational pipeline

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

Path parameters

organizationId*integer

Organization ID

pipelineId*integer

Pipeline ID

Query parameters

ignoreLastSuccessfulRunboolean

If set then EI_LAST_SUCCESSFUL_RUN is not set. You can use this to re-run a pipeline from scratch.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

pipelineRun*OrganizationPipelineRun (object)

id*integer

steps*array of OrganizationPipelineRunStep (object)

name*string

transformationJobOrganizationCreateProject (object)

id*integer

organizationId*integer

name*string

uploadType*enum

datasetproject

status*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

transformJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobIdinteger

uploadJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobFilesUploadedinteger

projectOwnerstring

projectIdinteger

projectNamestring

transformationBlockIdinteger

builtinTransformationBlockobject

transformationBlockNamestring

category*enum

trainingtestingsplit

created*string (date-time)

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

totalDownloadFileCount*integer

totalDownloadFileSize*integer

totalDownloadFileSizeString*string

totalUploadFileCount*integer

transformationParallel*integer

Number of transformation jobs that can be ran in parallel

transformationSummary*object

startedCount*integer

succeededCount*integer

finishedCount*integer

totalFileCount*integer

totalTimeSpentSeconds*integer

Total amount of compute used for this job (in seconds)

inProgress*boolean

labelstring

filterQuerystring

emailRecipientUidsarray of integer

itemsinteger

pipelineIdinteger

pipelineNamestring

pipelineRunIdinteger

pipelineStepinteger

operatesOn*TransformationJobOperatesOnEnum (enum)

filedirectorystandalone

totalTimeSpentSeconds*integer

Total amount of compute used for this job (in seconds)

totalTimeSpentString*string

Total amount of compute used (friendly string)

createdByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

filterstring

uploadTypeenum

projectdataset

projectIdinteger

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

categoryenum

trainingtestingsplit

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

labelstring

extraCliArgumentsstring

parametersobject

Other propertiesstring

created*string (date-time)

finishedstring (date-time)

itemCountBeforeOrganizationPipelineItemCount (object)

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistFailed*integer

itemCountAfterOrganizationPipelineItemCount (object)

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistFailed*integer

itemCountImportIntoProjectFailedinteger

Number of data items that failed to import into a project (through the s3-to-project, portal-to-project or dataset-to-project) transform blocks

Request

Response

Run pipeline

Run an organizational pipeline

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

Path parameters

organizationId*integer

Organization ID

pipelineId*integer

Pipeline ID

Query parameters

ignoreLastSuccessfulRunboolean

If set then EI_LAST_SUCCESSFUL_RUN is not set. You can use this to re-run a pipeline from scratch.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

pipelineRun*OrganizationPipelineRun (object)

id*integer

steps*array of OrganizationPipelineRunStep (object)

name*string

transformationJobOrganizationCreateProject (object)

id*integer

organizationId*integer

name*string

uploadType*enum

datasetproject

status*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

transformJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobIdinteger

uploadJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobFilesUploadedinteger

projectOwnerstring

projectIdinteger

projectNamestring

transformationBlockIdinteger

builtinTransformationBlockobject

transformationBlockNamestring

category*enum

trainingtestingsplit

created*string (date-time)

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

totalDownloadFileCount*integer

totalDownloadFileSize*integer

totalDownloadFileSizeString*string

totalUploadFileCount*integer

transformationParallel*integer

Number of transformation jobs that can be ran in parallel

transformationSummary*object

startedCount*integer

succeededCount*integer

finishedCount*integer

totalFileCount*integer

totalTimeSpentSeconds*integer

Total amount of compute used for this job (in seconds)

inProgress*boolean

labelstring

filterQuerystring

emailRecipientUidsarray of integer

itemsinteger

pipelineIdinteger

pipelineNamestring

pipelineRunIdinteger

pipelineStepinteger

operatesOn*TransformationJobOperatesOnEnum (enum)

filedirectorystandalone

totalTimeSpentSeconds*integer

Total amount of compute used for this job (in seconds)

totalTimeSpentString*string

Total amount of compute used (friendly string)

createdByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

filterstring

uploadTypeenum

projectdataset

projectIdinteger

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

categoryenum

trainingtestingsplit

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

labelstring

extraCliArgumentsstring

parametersobject

Other propertiesstring

created*string (date-time)

finishedstring (date-time)

itemCountBeforeOrganizationPipelineItemCount (object)

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistFailed*integer

itemCountAfterOrganizationPipelineItemCount (object)

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistFailed*integer

itemCountImportIntoProjectFailedinteger

Number of data items that failed to import into a project (through the s3-to-project, portal-to-project or dataset-to-project) transform blocks

Request

Response

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines/{pipelineId}/run', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

{
  "success": false,
  "error": "text",
  "pipelineRun": {
    "steps": [
      {
        "name": "text",
        "transformationJob": {
          "name": "text",
          "uploadType": "dataset",
          "status": "waiting",
          "transformJobStatus": "waiting",
          "uploadJobStatus": "waiting",
          "projectOwner": "text",
          "projectName": "text",
          "transformationBlockName": "text",
          "category": "training",
          "created": "2024-11-21T11:59:11.010Z",
          "outputDatasetName": "text",
          "outputDatasetBucketPath": "text",
          "totalDownloadFileSizeString": "text",
          "transformationSummary": {},
          "inProgress": false,
          "label": "text",
          "filterQuery": "text",
          "emailRecipientUids": [],
          "pipelineName": "text",
          "operatesOn": "file",
          "totalTimeSpentString": "text",
          "createdByUser": {
            "name": "text",
            "username": "text",
            "photo": "text"
          }
        },
        "filter": "text",
        "uploadType": "project",
        "newProjectName": "text",
        "projectApiKey": "text",
        "projectHmacKey": "text",
        "category": "training",
        "outputDatasetName": "text",
        "outputDatasetBucketPath": "text",
        "label": "text",
        "extraCliArguments": "text"
      }
    ],
    "created": "2024-11-21T11:59:11.010Z",
    "finished": "2024-11-21T11:59:11.010Z",
    "itemCountBefore": {},
    "itemCountAfter": {}
  }
}