Run pipeline

Run pipeline

Run an organizational pipeline

post

/api/organizations/{organizationId}/pipelines/{pipelineId}/run

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

pipelineIdintegerrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines/{pipelineId}/run' \
  --header 'x-api-key: YOUR_API_KEY'

200

200

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

OK