Skip to main content
POST
/
api
/
organizations
/
{organizationId}
/
pipelines
Create pipeline
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "steps": [
    {
      "name": "<string>",
      "filter": "<string>",
      "pathFilters": [
        {
          "dataset": "<string>",
          "filter": "<string>"
        }
      ],
      "projectId": 123,
      "newProjectName": "<string>",
      "projectApiKey": "<string>",
      "projectHmacKey": "<string>",
      "transformationBlockId": 123,
      "builtinTransformationBlock": {},
      "outputDatasetName": "<string>",
      "outputDatasetBucketId": 123,
      "outputDatasetBucketPath": "<string>",
      "outputPathInDataset": "<string>",
      "label": "<string>",
      "transformationParallel": 123,
      "extraCliArguments": "<string>",
      "parameters": {}
    }
  ],
  "emailRecipientUids": [
    123
  ],
  "intervalStr": "<string>",
  "dataset": "<string>",
  "projectId": 123,
  "notificationWebhook": "<string>",
  "archived": true
}
'
import requests

url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines"

payload = {
    "name": "<string>",
    "description": "<string>",
    "steps": [
        {
            "name": "<string>",
            "filter": "<string>",
            "pathFilters": [
                {
                    "dataset": "<string>",
                    "filter": "<string>"
                }
            ],
            "projectId": 123,
            "newProjectName": "<string>",
            "projectApiKey": "<string>",
            "projectHmacKey": "<string>",
            "transformationBlockId": 123,
            "builtinTransformationBlock": {},
            "outputDatasetName": "<string>",
            "outputDatasetBucketId": 123,
            "outputDatasetBucketPath": "<string>",
            "outputPathInDataset": "<string>",
            "label": "<string>",
            "transformationParallel": 123,
            "extraCliArguments": "<string>",
            "parameters": {}
        }
    ],
    "emailRecipientUids": [123],
    "intervalStr": "<string>",
    "dataset": "<string>",
    "projectId": 123,
    "notificationWebhook": "<string>",
    "archived": True
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    steps: [
      {
        name: '<string>',
        filter: '<string>',
        pathFilters: [{dataset: '<string>', filter: '<string>'}],
        projectId: 123,
        newProjectName: '<string>',
        projectApiKey: '<string>',
        projectHmacKey: '<string>',
        transformationBlockId: 123,
        builtinTransformationBlock: {},
        outputDatasetName: '<string>',
        outputDatasetBucketId: 123,
        outputDatasetBucketPath: '<string>',
        outputPathInDataset: '<string>',
        label: '<string>',
        transformationParallel: 123,
        extraCliArguments: '<string>',
        parameters: {}
      }
    ],
    emailRecipientUids: [123],
    intervalStr: '<string>',
    dataset: '<string>',
    projectId: 123,
    notificationWebhook: '<string>',
    archived: true
  })
};

fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'steps' => [
        [
                'name' => '<string>',
                'filter' => '<string>',
                'pathFilters' => [
                                [
                                                                'dataset' => '<string>',
                                                                'filter' => '<string>'
                                ]
                ],
                'projectId' => 123,
                'newProjectName' => '<string>',
                'projectApiKey' => '<string>',
                'projectHmacKey' => '<string>',
                'transformationBlockId' => 123,
                'builtinTransformationBlock' => [
                                
                ],
                'outputDatasetName' => '<string>',
                'outputDatasetBucketId' => 123,
                'outputDatasetBucketPath' => '<string>',
                'outputPathInDataset' => '<string>',
                'label' => '<string>',
                'transformationParallel' => 123,
                'extraCliArguments' => '<string>',
                'parameters' => [
                                
                ]
        ]
    ],
    'emailRecipientUids' => [
        123
    ],
    'intervalStr' => '<string>',
    'dataset' => '<string>',
    'projectId' => 123,
    'notificationWebhook' => '<string>',
    'archived' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"steps\": [\n    {\n      \"name\": \"<string>\",\n      \"filter\": \"<string>\",\n      \"pathFilters\": [\n        {\n          \"dataset\": \"<string>\",\n          \"filter\": \"<string>\"\n        }\n      ],\n      \"projectId\": 123,\n      \"newProjectName\": \"<string>\",\n      \"projectApiKey\": \"<string>\",\n      \"projectHmacKey\": \"<string>\",\n      \"transformationBlockId\": 123,\n      \"builtinTransformationBlock\": {},\n      \"outputDatasetName\": \"<string>\",\n      \"outputDatasetBucketId\": 123,\n      \"outputDatasetBucketPath\": \"<string>\",\n      \"outputPathInDataset\": \"<string>\",\n      \"label\": \"<string>\",\n      \"transformationParallel\": 123,\n      \"extraCliArguments\": \"<string>\",\n      \"parameters\": {}\n    }\n  ],\n  \"emailRecipientUids\": [\n    123\n  ],\n  \"intervalStr\": \"<string>\",\n  \"dataset\": \"<string>\",\n  \"projectId\": 123,\n  \"notificationWebhook\": \"<string>\",\n  \"archived\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"steps\": [\n    {\n      \"name\": \"<string>\",\n      \"filter\": \"<string>\",\n      \"pathFilters\": [\n        {\n          \"dataset\": \"<string>\",\n          \"filter\": \"<string>\"\n        }\n      ],\n      \"projectId\": 123,\n      \"newProjectName\": \"<string>\",\n      \"projectApiKey\": \"<string>\",\n      \"projectHmacKey\": \"<string>\",\n      \"transformationBlockId\": 123,\n      \"builtinTransformationBlock\": {},\n      \"outputDatasetName\": \"<string>\",\n      \"outputDatasetBucketId\": 123,\n      \"outputDatasetBucketPath\": \"<string>\",\n      \"outputPathInDataset\": \"<string>\",\n      \"label\": \"<string>\",\n      \"transformationParallel\": 123,\n      \"extraCliArguments\": \"<string>\",\n      \"parameters\": {}\n    }\n  ],\n  \"emailRecipientUids\": [\n    123\n  ],\n  \"intervalStr\": \"<string>\",\n  \"dataset\": \"<string>\",\n  \"projectId\": 123,\n  \"notificationWebhook\": \"<string>\",\n  \"archived\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"steps\": [\n    {\n      \"name\": \"<string>\",\n      \"filter\": \"<string>\",\n      \"pathFilters\": [\n        {\n          \"dataset\": \"<string>\",\n          \"filter\": \"<string>\"\n        }\n      ],\n      \"projectId\": 123,\n      \"newProjectName\": \"<string>\",\n      \"projectApiKey\": \"<string>\",\n      \"projectHmacKey\": \"<string>\",\n      \"transformationBlockId\": 123,\n      \"builtinTransformationBlock\": {},\n      \"outputDatasetName\": \"<string>\",\n      \"outputDatasetBucketId\": 123,\n      \"outputDatasetBucketPath\": \"<string>\",\n      \"outputPathInDataset\": \"<string>\",\n      \"label\": \"<string>\",\n      \"transformationParallel\": 123,\n      \"extraCliArguments\": \"<string>\",\n      \"parameters\": {}\n    }\n  ],\n  \"emailRecipientUids\": [\n    123\n  ],\n  \"intervalStr\": \"<string>\",\n  \"dataset\": \"<string>\",\n  \"projectId\": 123,\n  \"notificationWebhook\": \"<string>\",\n  \"archived\": true\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "id": 123,
  "error": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
integer
required

Organization ID

Body

application/json
name
string
required
description
string
required
steps
object[]
required
emailRecipientUids
integer[]
required
whenToEmail
enum<string>
required
Available options:
always,
on_new_data,
never
intervalStr
string

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

dataset
string
projectId
integer
notificationWebhook
string
archived
boolean

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

id
integer
required

Unique identifier of the created entity.

error
string

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