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

Body

success*boolean

Whether the operation succeeded

errorstring

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

pipelineRun*OrganizationPipelineRun (object)

Request

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

Response

{
  "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-21T08:32:10.848Z",
          "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-21T08:32:10.848Z",
    "finished": "2024-11-21T08:32:10.848Z",
    "itemCountBefore": {},
    "itemCountAfter": {}
  }
}

PreviousDelete pipeline NextStop a running pipeline

Last updated 7 months ago

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-21T08:32:10.848Z", "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-21T08:32:10.848Z", "finished": "2024-11-21T08:32:10.848Z", "itemCountBefore": {}, "itemCountAfter": {} } }