Skip to main content
POST
/
context
/
entitymatching
/
pipelines
Create pipelines
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/pipelines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "sources": {
        "dataSetIds": [
          {
            "id": 4503599627370496
          }
        ],
        "resource": "assets"
      },
      "targets": {
        "dataSetIds": [
          {
            "id": 4503599627370496
          }
        ],
        "resource": "assets"
      },
      "externalId": "my.known.id",
      "name": "myPipeline",
      "description": "My pipeline",
      "modelParameters": {
        "featureType": "bigram"
      },
      "trueMatches": [
        {
          "sourceId": 23
        }
      ],
      "confirmedMatches": [
        {
          "sourceId": 23
        }
      ],
      "rejectedMatches": [
        {
          "sourceId": 23
        }
      ],
      "useExistingMatches": false,
      "generateRules": true,
      "replacements": [
        {
          "field": "*",
          "string": "Bottom-hole pressure",
          "replacement": "bhp"
        }
      ],
      "rules": [],
      "rejectedRules": [],
      "scoreThreshold": 0.7,
      "scheduleInterval": 7200
    }
  ]
}
'
import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/pipelines"

payload = { "items": [
        {
            "sources": {
                "dataSetIds": [{ "id": 4503599627370496 }],
                "resource": "assets"
            },
            "targets": {
                "dataSetIds": [{ "id": 4503599627370496 }],
                "resource": "assets"
            },
            "externalId": "my.known.id",
            "name": "myPipeline",
            "description": "My pipeline",
            "modelParameters": { "featureType": "bigram" },
            "trueMatches": [{ "sourceId": 23 }],
            "confirmedMatches": [{ "sourceId": 23 }],
            "rejectedMatches": [{ "sourceId": 23 }],
            "useExistingMatches": False,
            "generateRules": True,
            "replacements": [
                {
                    "field": "*",
                    "string": "Bottom-hole pressure",
                    "replacement": "bhp"
                }
            ],
            "rules": [],
            "rejectedRules": [],
            "scoreThreshold": 0.7,
            "scheduleInterval": 7200
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {
        sources: {dataSetIds: [{id: 4503599627370496}], resource: 'assets'},
        targets: {dataSetIds: [{id: 4503599627370496}], resource: 'assets'},
        externalId: 'my.known.id',
        name: 'myPipeline',
        description: 'My pipeline',
        modelParameters: {featureType: 'bigram'},
        trueMatches: [{sourceId: 23}],
        confirmedMatches: [{sourceId: 23}],
        rejectedMatches: [{sourceId: 23}],
        useExistingMatches: false,
        generateRules: true,
        replacements: [{field: '*', string: 'Bottom-hole pressure', replacement: 'bhp'}],
        rules: [],
        rejectedRules: [],
        scoreThreshold: 0.7,
        scheduleInterval: 7200
      }
    ]
  })
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/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://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/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([
    'items' => [
        [
                'sources' => [
                                'dataSetIds' => [
                                                                [
                                                                                                                                'id' => 4503599627370496
                                                                ]
                                ],
                                'resource' => 'assets'
                ],
                'targets' => [
                                'dataSetIds' => [
                                                                [
                                                                                                                                'id' => 4503599627370496
                                                                ]
                                ],
                                'resource' => 'assets'
                ],
                'externalId' => 'my.known.id',
                'name' => 'myPipeline',
                'description' => 'My pipeline',
                'modelParameters' => [
                                'featureType' => 'bigram'
                ],
                'trueMatches' => [
                                [
                                                                'sourceId' => 23
                                ]
                ],
                'confirmedMatches' => [
                                [
                                                                'sourceId' => 23
                                ]
                ],
                'rejectedMatches' => [
                                [
                                                                'sourceId' => 23
                                ]
                ],
                'useExistingMatches' => false,
                'generateRules' => true,
                'replacements' => [
                                [
                                                                'field' => '*',
                                                                'string' => 'Bottom-hole pressure',
                                                                'replacement' => 'bhp'
                                ]
                ],
                'rules' => [
                                
                ],
                'rejectedRules' => [
                                
                ],
                'scoreThreshold' => 0.7,
                'scheduleInterval' => 7200
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/pipelines"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"sources\": {\n        \"dataSetIds\": [\n          {\n            \"id\": 4503599627370496\n          }\n        ],\n        \"resource\": \"assets\"\n      },\n      \"targets\": {\n        \"dataSetIds\": [\n          {\n            \"id\": 4503599627370496\n          }\n        ],\n        \"resource\": \"assets\"\n      },\n      \"externalId\": \"my.known.id\",\n      \"name\": \"myPipeline\",\n      \"description\": \"My pipeline\",\n      \"modelParameters\": {\n        \"featureType\": \"bigram\"\n      },\n      \"trueMatches\": [\n        {\n          \"sourceId\": 23\n        }\n      ],\n      \"confirmedMatches\": [\n        {\n          \"sourceId\": 23\n        }\n      ],\n      \"rejectedMatches\": [\n        {\n          \"sourceId\": 23\n        }\n      ],\n      \"useExistingMatches\": false,\n      \"generateRules\": true,\n      \"replacements\": [\n        {\n          \"field\": \"*\",\n          \"string\": \"Bottom-hole pressure\",\n          \"replacement\": \"bhp\"\n        }\n      ],\n      \"rules\": [],\n      \"rejectedRules\": [],\n      \"scoreThreshold\": 0.7,\n      \"scheduleInterval\": 7200\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/pipelines")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"sources\": {\n        \"dataSetIds\": [\n          {\n            \"id\": 4503599627370496\n          }\n        ],\n        \"resource\": \"assets\"\n      },\n      \"targets\": {\n        \"dataSetIds\": [\n          {\n            \"id\": 4503599627370496\n          }\n        ],\n        \"resource\": \"assets\"\n      },\n      \"externalId\": \"my.known.id\",\n      \"name\": \"myPipeline\",\n      \"description\": \"My pipeline\",\n      \"modelParameters\": {\n        \"featureType\": \"bigram\"\n      },\n      \"trueMatches\": [\n        {\n          \"sourceId\": 23\n        }\n      ],\n      \"confirmedMatches\": [\n        {\n          \"sourceId\": 23\n        }\n      ],\n      \"rejectedMatches\": [\n        {\n          \"sourceId\": 23\n        }\n      ],\n      \"useExistingMatches\": false,\n      \"generateRules\": true,\n      \"replacements\": [\n        {\n          \"field\": \"*\",\n          \"string\": \"Bottom-hole pressure\",\n          \"replacement\": \"bhp\"\n        }\n      ],\n      \"rules\": [],\n      \"rejectedRules\": [],\n      \"scoreThreshold\": 0.7,\n      \"scheduleInterval\": 7200\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/pipelines")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"sources\": {\n        \"dataSetIds\": [\n          {\n            \"id\": 4503599627370496\n          }\n        ],\n        \"resource\": \"assets\"\n      },\n      \"targets\": {\n        \"dataSetIds\": [\n          {\n            \"id\": 4503599627370496\n          }\n        ],\n        \"resource\": \"assets\"\n      },\n      \"externalId\": \"my.known.id\",\n      \"name\": \"myPipeline\",\n      \"description\": \"My pipeline\",\n      \"modelParameters\": {\n        \"featureType\": \"bigram\"\n      },\n      \"trueMatches\": [\n        {\n          \"sourceId\": 23\n        }\n      ],\n      \"confirmedMatches\": [\n        {\n          \"sourceId\": 23\n        }\n      ],\n      \"rejectedMatches\": [\n        {\n          \"sourceId\": 23\n        }\n      ],\n      \"useExistingMatches\": false,\n      \"generateRules\": true,\n      \"replacements\": [\n        {\n          \"field\": \"*\",\n          \"string\": \"Bottom-hole pressure\",\n          \"replacement\": \"bhp\"\n        }\n      ],\n      \"rules\": [],\n      \"rejectedRules\": [],\n      \"scoreThreshold\": 0.7,\n      \"scheduleInterval\": 7200\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "id": 4503599627370496,
      "createdTime": 1730204346000,
      "sources": {
        "dataSetIds": [
          {
            "id": 4503599627370496
          }
        ],
        "resource": "assets"
      },
      "targets": {
        "dataSetIds": [
          {
            "id": 4503599627370496
          }
        ],
        "resource": "assets"
      },
      "lastUpdatedTime": 1730204346000,
      "owner": "alice@example.com",
      "externalId": "my.known.id",
      "name": "myPipeline",
      "description": "My pipeline",
      "modelParameters": {
        "featureType": "bigram"
      },
      "trueMatches": [
        {
          "sourceId": 23
        }
      ],
      "confirmedMatches": [
        {
          "sourceId": 23
        }
      ],
      "rejectedMatches": [
        {
          "sourceId": 23
        }
      ],
      "useExistingMatches": false,
      "generateRules": true,
      "replacements": [
        {
          "field": "*",
          "string": "Bottom-hole pressure",
          "replacement": "bhp"
        }
      ],
      "rules": [],
      "rejectedRules": [],
      "scoreThreshold": 0.7,
      "scheduleInterval": 7200
    }
  ]
}
{
  "error": {
    "code": 400,
    "message": "`null` values aren't allowed."
  }
}

Authorizations

​
Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Body

application/json
​
items
object[]
required

Pipelines to create

Required array length: 1 - 100 elements

Response

Created pipelines

​
items
object[]
required
Last modified on July 13, 2026