---
title: "Run pipeline"
method: POST
path: "/api/organizations/{organizationId}/pipelines/{pipelineId}/run"
tags: ["OrganizationPipelines"]
---

# Run pipeline

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

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines/{pipelineId}/run`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - 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/pipelines/:pipelineId/run/post.ts> (a function with typed inputs; its response is checked against the schema)

Run an organizational pipeline

## Path parameters

- `organizationId` integer, required
- `pipelineId` integer, required

## Query parameters

- `ignoreLastSuccessfulRun` boolean

## Response `200`

OK

- RunOrganizationPipelineResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `pipelineRun` OrganizationPipelineRun, required
    - `id` integer, required
    - `steps` OrganizationPipelineRunStep[], required
      - `name` string, required
      - `transformationJob` OrganizationCreateProject
        - `id` integer, required
        - `organizationId` integer, required
        - `name` string, required
        - `uploadType` 'dataset' | 'project', required
        - `status` 'waiting' | 'created' | 'started' | 'finished' | 'failed', required
        - `transformJobStatus` 'waiting' | 'created' | 'started' | 'finished' | 'failed', required
        - `uploadJobId` integer
        - `uploadJobStatus` 'waiting' | 'created' | 'started' | 'finished' | 'failed', required
        - `uploadJobFilesUploaded` integer
        - `projectOwner` string
        - `projectId` integer
        - `projectName` string
        - `transformationBlockId` integer
        - `builtinTransformationBlock` object
        - `transformationBlockName` string
        - `category` 'training' | 'validation' | 'testing' | 'split', required
        - `created` string, date-time, required
        - `outputDatasetName` string
        - `outputDatasetBucketId` integer
        - `outputDatasetBucketPath` string
        - `totalDownloadFileCount` integer, required
        - `totalDownloadFileSize` integer, required
        - `totalDownloadFileSizeString` string, required
        - `totalUploadFileCount` integer, required
        - `transformationParallel` integer, required: Number of transformation jobs that can be ran in parallel
        - `transformationSummary` object, required
          - `startedCount` integer, required
          - `succeededCount` integer, required
          - `finishedCount` integer, required
          - `totalFileCount` integer, required
          - `totalTimeSpentSeconds` integer, required: Total amount of compute used for this job (in seconds)
        - `inProgress` boolean, required
        - `label` string
        - `filterQuery` string
        - `emailRecipientUids` integer[]
        - `pipelineId` integer
        - `pipelineName` string
        - `pipelineRunId` integer
        - `pipelineStep` integer
        - `operatesOn` 'file' | 'directory' | 'standalone', required
        - `totalTimeSpentSeconds` integer, required: Total amount of compute used for this job (in seconds)
        - `totalTimeSpentString` string, required: Total amount of compute used (friendly string)
        - `createdByUser` CreatedUpdatedByUser
          - `id` integer, required
          - `name` string, required
          - `username` string, required
          - `photo` string
      - `filter` string
      - `uploadType` 'project' | 'dataset'
      - `projectId` integer
      - `newProjectName` string
      - `projectApiKey` string
      - `projectHmacKey` string
      - `transformationBlockId` integer
      - `builtinTransformationBlock` object
      - `category` 'training' | 'validation' | 'testing' | 'split'
      - `outputDatasetName` string
      - `outputDatasetBucketId` integer
      - `outputDatasetBucketPath` string
      - `label` string
      - `extraCliArguments` string
      - `parameters` object
    - `created` string, date-time, required
    - `finished` string, date-time
    - `itemCountBefore` OrganizationPipelineItemCount
      - `itemCount` integer, required
      - `itemCountChecklistOK` integer, required
      - `itemCountChecklistFailed` integer, required
    - `itemCountAfter` OrganizationPipelineItemCount
      - `itemCount` integer, required
      - `itemCountChecklistOK` integer, required
      - `itemCountChecklistFailed` integer, required
    - `itemCountImportIntoProjectFailed` integer: 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

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)