Get pipeline
Retrieve an organizational pipelines
Authorizations
Path parameters
organizationIdintegerRequired
Organization ID
pipelineIdintegerRequired
Pipeline ID
Responses
200
OK
application/json
Responseall of
get
GET /v1/api/organizations/{organizationId}/pipelines/{pipelineId} HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*
200
OK
{
"success": true,
"error": "text",
"pipeline": {
"id": 1,
"name": "text",
"description": "text",
"intervalStr": "text",
"steps": [
{
"name": "text",
"filter": "text",
"pathFilters": [
{
"dataset": "text",
"filter": "text"
}
],
"uploadType": "project",
"projectId": 1,
"newProjectName": "text",
"projectApiKey": "text",
"projectHmacKey": "text",
"transformationBlockId": 1,
"builtinTransformationBlock": {},
"category": "training",
"outputDatasetName": "text",
"outputDatasetBucketId": 1,
"outputDatasetBucketPath": "text",
"outputPathInDataset": "text",
"outputDatasetPathRule": "no-subfolders",
"label": "text",
"transformationParallel": 1,
"extraCliArguments": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"nextRun": "2025-04-30T18:22:08.376Z",
"created": "2025-04-30T18:22:08.376Z",
"currentRun": {
"id": 1,
"steps": [
{
"name": "text",
"transformationJob": {
"id": 1,
"organizationId": 1,
"name": "text",
"uploadType": "dataset",
"status": "waiting",
"transformJobStatus": "waiting",
"uploadJobId": 1,
"uploadJobStatus": "waiting",
"uploadJobFilesUploaded": 1,
"projectOwner": "text",
"projectId": 1,
"projectName": "text",
"transformationBlockId": 1,
"builtinTransformationBlock": {},
"transformationBlockName": "text",
"category": "training",
"created": "2025-04-30T18:22:08.376Z",
"outputDatasetName": "text",
"outputDatasetBucketId": 1,
"outputDatasetBucketPath": "text",
"totalDownloadFileCount": 1,
"totalDownloadFileSize": 1,
"totalDownloadFileSizeString": "text",
"totalUploadFileCount": 1,
"transformationParallel": 1,
"transformationSummary": {
"startedCount": 1,
"succeededCount": 1,
"finishedCount": 1,
"totalFileCount": 1,
"totalTimeSpentSeconds": 1
},
"inProgress": true,
"label": "text",
"filterQuery": "text",
"emailRecipientUids": [
1
],
"pipelineId": 1,
"pipelineName": "text",
"pipelineRunId": 1,
"pipelineStep": 1,
"operatesOn": "file",
"totalTimeSpentSeconds": 1,
"totalTimeSpentString": "text",
"createdByUser": {
"id": 1,
"name": "text",
"username": "text",
"photo": "text"
}
},
"filter": "text",
"uploadType": "project",
"projectId": 1,
"newProjectName": "text",
"projectApiKey": "text",
"projectHmacKey": "text",
"transformationBlockId": 1,
"builtinTransformationBlock": {},
"category": "training",
"outputDatasetName": "text",
"outputDatasetBucketId": 1,
"outputDatasetBucketPath": "text",
"label": "text",
"extraCliArguments": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"created": "2025-04-30T18:22:08.376Z",
"finished": "2025-04-30T18:22:08.376Z",
"itemCountBefore": {
"itemCount": 1,
"itemCountChecklistOK": 1,
"itemCountChecklistFailed": 1
},
"itemCountAfter": {
"itemCount": 1,
"itemCountChecklistOK": 1,
"itemCountChecklistFailed": 1
},
"itemCountImportIntoProjectFailed": 1
},
"lastRun": {
"id": 1,
"steps": [
{
"name": "text",
"transformationJob": {
"id": 1,
"organizationId": 1,
"name": "text",
"uploadType": "dataset",
"status": "waiting",
"transformJobStatus": "waiting",
"uploadJobId": 1,
"uploadJobStatus": "waiting",
"uploadJobFilesUploaded": 1,
"projectOwner": "text",
"projectId": 1,
"projectName": "text",
"transformationBlockId": 1,
"builtinTransformationBlock": {},
"transformationBlockName": "text",
"category": "training",
"created": "2025-04-30T18:22:08.376Z",
"outputDatasetName": "text",
"outputDatasetBucketId": 1,
"outputDatasetBucketPath": "text",
"totalDownloadFileCount": 1,
"totalDownloadFileSize": 1,
"totalDownloadFileSizeString": "text",
"totalUploadFileCount": 1,
"transformationParallel": 1,
"transformationSummary": {
"startedCount": 1,
"succeededCount": 1,
"finishedCount": 1,
"totalFileCount": 1,
"totalTimeSpentSeconds": 1
},
"inProgress": true,
"label": "text",
"filterQuery": "text",
"emailRecipientUids": [
1
],
"pipelineId": 1,
"pipelineName": "text",
"pipelineRunId": 1,
"pipelineStep": 1,
"operatesOn": "file",
"totalTimeSpentSeconds": 1,
"totalTimeSpentString": "text",
"createdByUser": {
"id": 1,
"name": "text",
"username": "text",
"photo": "text"
}
},
"filter": "text",
"uploadType": "project",
"projectId": 1,
"newProjectName": "text",
"projectApiKey": "text",
"projectHmacKey": "text",
"transformationBlockId": 1,
"builtinTransformationBlock": {},
"category": "training",
"outputDatasetName": "text",
"outputDatasetBucketId": 1,
"outputDatasetBucketPath": "text",
"label": "text",
"extraCliArguments": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"created": "2025-04-30T18:22:08.376Z",
"finished": "2025-04-30T18:22:08.376Z",
"itemCountBefore": {
"itemCount": 1,
"itemCountChecklistOK": 1,
"itemCountChecklistFailed": 1
},
"itemCountAfter": {
"itemCount": 1,
"itemCountChecklistOK": 1,
"itemCountChecklistFailed": 1
},
"itemCountImportIntoProjectFailed": 1
},
"feedingIntoDataset": {
"dataset": "text",
"datasetLink": "text",
"itemCount": 1,
"itemCountChecklistOK": 1,
"itemCountChecklistError": 1,
"datasetType": "clinical"
},
"feedingIntoProject": {
"id": 1,
"name": "text",
"projectLink": "text",
"itemCount": 1
},
"emailRecipientUids": [
1
],
"lastRunStartError": "text",
"notificationWebhook": "text",
"whenToEmail": "always"
}
}Last updated
Was this helpful?