Update pipeline

Update pipeline

Update an organizational pipelines

post

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

pipelineIdintegerrequired

Pipeline ID

Body

namestringrequired

descriptionstringrequired

intervalStrstring

15m for every 15 minutes, 2h for every 2 hours, 1d for every 1 day

stepsobject[]required

datasetstring

projectIdinteger

emailRecipientUidsinteger[]required

notificationWebhookstring

whenToEmailstring · enumrequired

Options: always, on_new_data, never

archivedboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines/{pipelineId}' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
        }
      }
    ],
    "dataset": "text",
    "projectId": 1,
    "emailRecipientUids": [
      1
    ],
    "notificationWebhook": "text",
    "whenToEmail": "always",
    "archived": true
  }'

200

200

{
  "success": true,
  "error": "text"
}

OK