Run pipeline

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

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

pipelineRun*OrganizationPipelineRun (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false,
  "error": "text",
  "pipelineRun": {
    "id": 0,
    "steps": [
      {
        "name": "text",
        "transformationJob": {
          "id": 0,
          "organizationId": 0,
          "name": "text",
          "uploadType": "dataset",
          "status": "waiting",
          "transformJobStatus": "waiting",
          "uploadJobId": 0,
          "uploadJobStatus": "waiting",
          "uploadJobFilesUploaded": 0,
          "projectOwner": "text",
          "projectId": 0,
          "projectName": "text",
          "transformationBlockId": 0,
          "transformationBlockName": "text",
          "category": "training",
          "created": "2025-01-21T00:59:36.701Z",
          "outputDatasetName": "text",
          "outputDatasetBucketId": 0,
          "outputDatasetBucketPath": "text",
          "totalDownloadFileCount": 0,
          "totalDownloadFileSize": 0,
          "totalDownloadFileSizeString": "text",
          "totalUploadFileCount": 0,
          "transformationParallel": 0,
          "transformationSummary": {
            "startedCount": 0,
            "succeededCount": 0,
            "finishedCount": 0,
            "totalFileCount": 0,
            "totalTimeSpentSeconds": 0
          },
          "inProgress": false,
          "label": "text",
          "filterQuery": "text",
          "emailRecipientUids": [
            0
          ],
          "pipelineId": 0,
          "pipelineName": "text",
          "pipelineRunId": 0,
          "pipelineStep": 0,
          "operatesOn": "file",
          "totalTimeSpentSeconds": 0,
          "totalTimeSpentString": "text",
          "createdByUser": {
            "id": 0,
            "name": "text",
            "username": "text",
            "photo": "text"
          }
        },
        "filter": "text",
        "uploadType": "project",
        "projectId": 0,
        "newProjectName": "text",
        "projectApiKey": "text",
        "projectHmacKey": "text",
        "transformationBlockId": 0,
        "category": "training",
        "outputDatasetName": "text",
        "outputDatasetBucketId": 0,
        "outputDatasetBucketPath": "text",
        "label": "text",
        "extraCliArguments": "text"
      }
    ],
    "created": "2025-01-21T00:59:36.701Z",
    "finished": "2025-01-21T00:59:36.701Z",
    "itemCountBefore": {
      "itemCount": 0,
      "itemCountChecklistOK": 0,
      "itemCountChecklistFailed": 0
    },
    "itemCountAfter": {
      "itemCount": 0,
      "itemCountChecklistOK": 0,
      "itemCountChecklistFailed": 0
    },
    "itemCountImportIntoProjectFailed": 0
  }
}